Pinpoint.Client¶A low-level client representing Amazon Pinpoint
Doc Engage API - Amazon Pinpoint API
import boto3
client = boto3.client('pinpoint')
These are the available methods:
can_paginate()close()create_app()create_campaign()create_email_template()create_export_job()create_import_job()create_in_app_template()create_journey()create_push_template()create_recommender_configuration()create_segment()create_sms_template()create_voice_template()delete_adm_channel()delete_apns_channel()delete_apns_sandbox_channel()delete_apns_voip_channel()delete_apns_voip_sandbox_channel()delete_app()delete_baidu_channel()delete_campaign()delete_email_channel()delete_email_template()delete_endpoint()delete_event_stream()delete_gcm_channel()delete_in_app_template()delete_journey()delete_push_template()delete_recommender_configuration()delete_segment()delete_sms_channel()delete_sms_template()delete_user_endpoints()delete_voice_channel()delete_voice_template()get_adm_channel()get_apns_channel()get_apns_sandbox_channel()get_apns_voip_channel()get_apns_voip_sandbox_channel()get_app()get_application_date_range_kpi()get_application_settings()get_apps()get_baidu_channel()get_campaign()get_campaign_activities()get_campaign_date_range_kpi()get_campaign_version()get_campaign_versions()get_campaigns()get_channels()get_email_channel()get_email_template()get_endpoint()get_event_stream()get_export_job()get_export_jobs()get_gcm_channel()get_import_job()get_import_jobs()get_in_app_messages()get_in_app_template()get_journey()get_journey_date_range_kpi()get_journey_execution_activity_metrics()get_journey_execution_metrics()get_paginator()get_push_template()get_recommender_configuration()get_recommender_configurations()get_segment()get_segment_export_jobs()get_segment_import_jobs()get_segment_version()get_segment_versions()get_segments()get_sms_channel()get_sms_template()get_user_endpoints()get_voice_channel()get_voice_template()get_waiter()list_journeys()list_tags_for_resource()list_template_versions()list_templates()phone_number_validate()put_event_stream()put_events()remove_attributes()send_messages()send_otp_message()send_users_messages()tag_resource()untag_resource()update_adm_channel()update_apns_channel()update_apns_sandbox_channel()update_apns_voip_channel()update_apns_voip_sandbox_channel()update_application_settings()update_baidu_channel()update_campaign()update_email_channel()update_email_template()update_endpoint()update_endpoints_batch()update_gcm_channel()update_in_app_template()update_journey()update_journey_state()update_push_template()update_recommender_configuration()update_segment()update_sms_channel()update_sms_template()update_template_active_version()update_voice_channel()update_voice_template()verify_otp_message()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_app(**kwargs)¶Creates an application.
See also: AWS API Documentation
Request Syntax
response = client.create_app(
CreateApplicationRequest={
'Name': 'string',
'tags': {
'string': 'string'
}
}
)
[REQUIRED]
Specifies the display name of an application and the tags to associate with the application.
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.
{
'ApplicationResponse': {
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'tags': {
'string': 'string'
},
'CreationDate': 'string'
}
}
Response Structure
The request succeeded and the specified resource was created.
Provides information about an application.
The Amazon Resource Name (ARN) of the application.
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.
The date and time when the Application was created.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptioncreate_campaign(**kwargs)¶Creates a new campaign for an application or updates the settings of an existing campaign for an application.
See also: AWS API Documentation
Request Syntax
response = client.create_campaign(
ApplicationId='string',
WriteCampaignRequest={
'AdditionalTreatments': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'IsPaused': True|False,
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123,
'Session': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Priority': 123
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the configuration and other settings for a campaign.
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
The destination to send the campaign or treatment to. This value can be one of the following:
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
The message configuration settings for the treatment.
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
The default message that the campaign sends through all the channels that are configured for the campaign.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
The body of the email for recipients whose email clients don't render HTML content.
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
The body of the email, in HTML format, for recipients whose email clients render HTML content.
The subject line, or title, of the email.
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
The body of the SMS message.
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
The sender ID to display on recipients' devices when they receive the SMS message.
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
The template ID received from the regulatory body for sending SMS in your country.
The in-app message configuration.
The message body of the notification, the email body or the text message.
In-app message content.
The configuration for the message content.
The background color for the message.
The configuration for the message body.
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Message Body.
The text color.
The configuration for the message header.
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Message Header.
The text color.
The image url for the background of message.
The first button inside the message.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
The background color of the button.
The border radius of the button.
Action triggered by the button.
Button destination.
Button text.
The text color of the button.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
Action triggered by the button.
Button destination.
The second button inside message.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
The background color of the button.
The border radius of the button.
Action triggered by the button.
Button destination.
Button text.
The text color of the button.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
Action triggered by the button.
Button destination.
Custom config to be sent to client.
In-app message layout.
The schedule settings for the treatment.
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
The dimension settings of the event filter for the campaign.
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
The allocated percentage of users (segment members) to send the treatment to.
The message template to use for the treatment.
The email template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The push notification template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The SMS template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The voice template to use for the message. This object isn't supported for campaigns.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
A custom description of the treatment.
A custom name for the treatment.
The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.
The destination to send the campaign or treatment to. This value can be one of the following:
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
A custom description of the campaign.
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
The messaging limits for the campaign.
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
The maximum total number of messages that the campaign can send per user session.
The message configuration settings for the campaign.
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
The default message that the campaign sends through all the channels that are configured for the campaign.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
The body of the email for recipients whose email clients don't render HTML content.
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
The body of the email, in HTML format, for recipients whose email clients render HTML content.
The subject line, or title, of the email.
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
The body of the SMS message.
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
The sender ID to display on recipients' devices when they receive the SMS message.
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
The template ID received from the regulatory body for sending SMS in your country.
The in-app message configuration.
The message body of the notification, the email body or the text message.
In-app message content.
The configuration for the message content.
The background color for the message.
The configuration for the message body.
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Message Body.
The text color.
The configuration for the message header.
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Message Header.
The text color.
The image url for the background of message.
The first button inside the message.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
The background color of the button.
The border radius of the button.
Action triggered by the button.
Button destination.
Button text.
The text color of the button.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
Action triggered by the button.
Button destination.
The second button inside message.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
The background color of the button.
The border radius of the button.
Action triggered by the button.
Button destination.
Button text.
The text color of the button.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
Action triggered by the button.
Button destination.
Custom config to be sent to client.
In-app message layout.
A custom name for the campaign.
The schedule settings for the campaign.
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
The dimension settings of the event filter for the campaign.
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
The unique identifier for the segment to associate with the campaign.
The version of the segment to associate with the campaign.
A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.
The message template to use for the campaign.
The email template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The push notification template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The SMS template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The voice template to use for the message. This object isn't supported for campaigns.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
A custom description of the default treatment for the campaign.
A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123,
'Session': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123,
'Priority': 123
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
CampaignResponse (dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
InAppMessage (dict) --
The in-app message configuration.
Body (string) --
The message body of the notification, the email body or the text message.
Content (list) --
In-app message content.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CustomConfig (dict) --
Custom config to be sent to client.
Layout (string) --
In-app message layout.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The current status of the treatment.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
TemplateConfiguration (dict) --
The message template to use for the treatment.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
Session (integer) --
The maximum total number of messages that the campaign can send per user session.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
InAppMessage (dict) --
The in-app message configuration.
Body (string) --
The message body of the notification, the email body or the text message.
Content (list) --
In-app message content.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CustomConfig (dict) --
Custom config to be sent to client.
Layout (string) --
In-app message layout.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
TemplateConfiguration (dict) --
The message template that’s used for the campaign.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the default treatment for the campaign.
TreatmentName (string) --
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
Priority (integer) --
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptioncreate_email_template(**kwargs)¶Creates a message template for messages that are sent through the email channel.
See also: AWS API Documentation
Request Syntax
response = client.create_email_template(
EmailTemplateRequest={
'DefaultSubstitutions': 'string',
'HtmlPart': 'string',
'RecommenderId': 'string',
'Subject': 'string',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string',
'TextPart': 'string'
},
TemplateName='string'
)
[REQUIRED]
Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.
A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
The subject line, or title, to use in email messages that are based on the message template.
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
A custom description of the message template.
The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'CreateTemplateMessageBody': {
'Arn': 'string',
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
CreateTemplateMessageBody (dict) --
Provides information about a request to create a message template.
Arn (string) --
The Amazon Resource Name (ARN) of the message template that was created.
Message (string) --
The message that's returned from the API for the request to create the message template.
RequestID (string) --
The unique identifier for the request to create the message template.
Exceptions
Pinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionPinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.ForbiddenExceptioncreate_export_job(**kwargs)¶Creates an export job for an application.
See also: AWS API Documentation
Request Syntax
response = client.create_export_job(
ApplicationId='string',
ExportJobRequest={
'RoleArn': 'string',
'S3UrlPrefix': 'string',
'SegmentId': 'string',
'SegmentVersion': 123
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.
The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.
The version of the segment to export endpoint definitions from, if specified.
dict
Response Syntax
{
'ExportJobResponse': {
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'RoleArn': 'string',
'S3UrlPrefix': 'string',
'SegmentId': 'string',
'SegmentVersion': 123
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'PREPARING_FOR_INITIALIZATION'|'INITIALIZING'|'PROCESSING'|'PENDING_JOB'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
ExportJobResponse (dict) --
Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the export job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the export job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the export job was created.
Definition (dict) --
The resource settings that apply to the export job.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.
S3UrlPrefix (string) --
The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
SegmentId (string) --
The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.
SegmentVersion (integer) --
The version of the segment that the endpoint definitions were exported from.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
Id (string) --
The unique identifier for the export job.
JobStatus (string) --
The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the export job.
Type (string) --
The job type. This value is EXPORT for export jobs.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptioncreate_import_job(**kwargs)¶Creates an import job for an application.
See also: AWS API Documentation
Request Syntax
response = client.create_import_job(
ApplicationId='string',
ImportJobRequest={
'DefineSegment': True|False,
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RegisterEndpoints': True|False,
'RoleArn': 'string',
'S3Url': 'string',
'SegmentId': 'string',
'SegmentName': 'string'
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.
Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
dict
Response Syntax
{
'ImportJobResponse': {
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'DefineSegment': True|False,
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RegisterEndpoints': True|False,
'RoleArn': 'string',
'S3Url': 'string',
'SegmentId': 'string',
'SegmentName': 'string'
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'PREPARING_FOR_INITIALIZATION'|'INITIALIZING'|'PROCESSING'|'PENDING_JOB'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
ImportJobResponse (dict) --
Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the import job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the import job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the import job was created.
Definition (dict) --
The resource settings that apply to the import job.
DefineSegment (boolean) --
Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
RegisterEndpoints (boolean) --
Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
SegmentId (string) --
The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
SegmentName (string) --
The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
Id (string) --
The unique identifier for the import job.
JobStatus (string) --
The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the import job.
Type (string) --
The job type. This value is IMPORT for import jobs.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptioncreate_in_app_template(**kwargs)¶Creates a new message template for messages using the in-app message channel.
See also: AWS API Documentation
Request Syntax
response = client.create_in_app_template(
InAppTemplateRequest={
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string'
},
TemplateName='string'
)
[REQUIRED]
InApp Template Request.
The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
The configuration for the message content.
The background color for the message.
The configuration for the message body.
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Message Body.
The text color.
The configuration for the message header.
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Message Header.
The text color.
The image url for the background of message.
The first button inside the message.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
The background color of the button.
The border radius of the button.
Action triggered by the button.
Button destination.
Button text.
The text color of the button.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
Action triggered by the button.
Button destination.
The second button inside message.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
The background color of the button.
The border radius of the button.
Action triggered by the button.
Button destination.
Button text.
The text color of the button.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
Action triggered by the button.
Button destination.
Custom config to be sent to client.
The layout of the message.
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
The description of the template.
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'TemplateCreateMessageBody': {
'Arn': 'string',
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
TemplateCreateMessageBody (dict) --
Provides information about a request to create a message template.
Arn (string) --
The Amazon Resource Name (ARN) of the message template that was created.
Message (string) --
The message that's returned from the API for the request to create the message template.
RequestID (string) --
The unique identifier for the request to create the message template.
Exceptions
Pinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionPinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.ForbiddenExceptioncreate_journey(**kwargs)¶Creates a journey for an application.
See also: AWS API Documentation
Request Syntax
response = client.create_journey(
ApplicationId='string',
WriteJourneyRequest={
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'ContactCenter': {
'NextActivity': 'string'
}
}
},
'CreationDate': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123,
'EndpointReentryInterval': 'string'
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED'|'PAUSED',
'WaitForQuietTime': True|False,
'RefreshOnSegmentUpdate': True|False,
'JourneyChannelSettings': {
'ConnectCampaignArn': 'string',
'ConnectCampaignExecutionRoleArn': 'string'
},
'SendingSchedule': True|False,
'OpenHours': {
'EMAIL': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'SMS': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'PUSH': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'VOICE': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'CUSTOM': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
}
},
'ClosedDays': {
'EMAIL': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'SMS': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'PUSH': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'VOICE': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'CUSTOM': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
]
}
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the configuration and other settings for a journey.
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.
Specifies the configuration and other settings for an activity in a journey.
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
The destination to send the campaign or treatment to. This value can be one of the following:
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
Specifies the message data included in a custom channel message that's sent to participants in a journey.
The message content that's passed to an AWS Lambda function or to a web hook.
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
The conditions that define the paths for the activity, and the relationship between the conditions.
The conditions to evaluate for the activity.
Specifies a condition to evaluate for an activity in a journey.
The dimension settings for the event that's associated with the activity.
The dimensions for the event filter to use for the activity.
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
The segment that's associated with the activity.
The unique identifier for the segment to associate with the activity.
The dimension settings for the segment that's associated with the activity.
One or more custom attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The behavior-based criteria, such as how recently users have used your app, for the segment.
The dimension settings that are based on how recently an endpoint was active.
The duration to use when determining whether an endpoint is active or inactive.
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
The demographic-based criteria, such as device platform, for the segment.
The app version criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The channel criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device type criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device make criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device model criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device platform criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The location-based criteria, such as region or GPS coordinates, for the segment.
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The GPS location and range for the segment.
The GPS coordinates to measure distance from.
The latitude coordinate of the location.
The longitude coordinate of the location.
The range, in kilometers, from the GPS coordinates.
One or more custom metrics to use as criteria for the segment.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
One or more custom user attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
The unique identifier for the activity to perform if the conditions aren't met.
The unique identifier for the activity to perform if the conditions are met.
The custom description of the activity.
The settings for an email activity. This type of activity sends an email message to participants.
Specifies the sender address for an email message that's sent to participants in the journey.
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
The unique identifier for the next activity to perform, after the message is sent.
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
The unique identifier for the next activity to perform, after performing the holdout activity.
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
Specifies a condition to evaluate for an activity path in a journey.
The condition to evaluate for the activity path.
The dimension settings for the event that's associated with the activity.
The dimensions for the event filter to use for the activity.
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
The segment that's associated with the activity.
The unique identifier for the segment to associate with the activity.
The dimension settings for the segment that's associated with the activity.
One or more custom attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The behavior-based criteria, such as how recently users have used your app, for the segment.
The dimension settings that are based on how recently an endpoint was active.
The duration to use when determining whether an endpoint is active or inactive.
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
The demographic-based criteria, such as device platform, for the segment.
The app version criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The channel criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device type criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device make criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device model criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device platform criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The location-based criteria, such as region or GPS coordinates, for the segment.
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The GPS location and range for the segment.
The GPS coordinates to measure distance from.
The latitude coordinate of the location.
The longitude coordinate of the location.
The range, in kilometers, from the GPS coordinates.
One or more custom metrics to use as criteria for the segment.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
One or more custom user attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The unique identifier for the next activity to perform, after completing the activity for the path.
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
The settings for a push notification activity. This type of activity sends a push notification to participants.
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The unique identifier for the next activity to perform, after the message is sent.
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
Specifies the settings for a path in a random split activity in a journey.
The unique identifier for the next activity to perform, after completing the activity for the path.
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
The settings for an SMS activity. This type of activity sends a text message to participants.
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
The template ID received from the regulatory body for sending SMS in your country.
The unique identifier for the next activity to perform, after the message is sent.
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
The unique identifier for the next activity to perform, after performing the wait activity.
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
The settings for a connect activity. This type of activity initiates a contact center call to participants.
The unique identifier for the next activity to perform after the this activity.
The date, in ISO 8601 format, when the journey was created.
The date, in ISO 8601 format, when the journey was last modified.
The messaging and entry limits for the journey.
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
The maximum number of messages that the journey can send each second.
Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.
Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.
The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
The schedule settings for the journey.
The scheduled time, in ISO 8601 format, when the journey ended or will end.
The scheduled time, in ISO 8601 format, when the journey began or will begin.
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.
The segment that defines which users are participants in the journey.
The custom description of the condition.
Specifies the settings for an event that causes a journey activity to start.
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
The dimensions for the event filter to use for the campaign or the journey activity.
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
The unique identifier for the segment to associate with the activity.
The status of the journey. Valid values are:
PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the Journey Stateresource.
Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
Specifies whether a journey should be refreshed on segment update.
The channel-specific configurations for the journey.
Amazon Resource Name (ARN) of the Connect Campaign.
IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)
The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
Rules for Email Channel.
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
Open Hour Rules.
Open Hour Rule Details.
Local start time in ISO 8601 format.
Local start time in ISO 8601 format.
Rules for SMS Channel.
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
Open Hour Rules.
Open Hour Rule Details.
Local start time in ISO 8601 format.
Local start time in ISO 8601 format.
Rules for Push Channel.
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
Open Hour Rules.
Open Hour Rule Details.
Local start time in ISO 8601 format.
Local start time in ISO 8601 format.
Rules for Voice Channel.
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
Open Hour Rules.
Open Hour Rule Details.
Local start time in ISO 8601 format.
Local start time in ISO 8601 format.
Rules for Custom Channel.
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
Open Hour Rules.
Open Hour Rule Details.
Local start time in ISO 8601 format.
Local start time in ISO 8601 format.
The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.
Rules for Email Channel.
ClosedDays rule details.
Name of the rule.
Start Datetime in ISO 8601 format.
End Datetime in ISO 8601 format.
Rules for SMS Channel.
ClosedDays rule details.
Name of the rule.
Start Datetime in ISO 8601 format.
End Datetime in ISO 8601 format.
Rules for Push Channel.
ClosedDays rule details.
Name of the rule.
Start Datetime in ISO 8601 format.
End Datetime in ISO 8601 format.
Rules for Voice Channel.
ClosedDays rule details.
Name of the rule.
Start Datetime in ISO 8601 format.
End Datetime in ISO 8601 format.
Rules for Custom Channel.
ClosedDays rule details.
Name of the rule.
Start Datetime in ISO 8601 format.
End Datetime in ISO 8601 format.
dict
Response Syntax
{
'JourneyResponse': {
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'ContactCenter': {
'NextActivity': 'string'
}
}
},
'ApplicationId': 'string',
'CreationDate': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123,
'EndpointReentryInterval': 'string'
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED'|'PAUSED',
'tags': {
'string': 'string'
},
'WaitForQuietTime': True|False,
'RefreshOnSegmentUpdate': True|False,
'JourneyChannelSettings': {
'ConnectCampaignArn': 'string',
'ConnectCampaignExecutionRoleArn': 'string'
},
'SendingSchedule': True|False,
'OpenHours': {
'EMAIL': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'SMS': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'PUSH': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'VOICE': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'CUSTOM': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
}
},
'ClosedDays': {
'EMAIL': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'SMS': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'PUSH': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'VOICE': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'CUSTOM': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
]
}
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
JourneyResponse (dict) --
Provides information about the status, configuration, and other settings for a journey.
Activities (dict) --
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
(string) --
(dict) --
Specifies the configuration and other settings for an activity in a journey.
CUSTOM (dict) --
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
MessageConfig (dict) --
Specifies the message data included in a custom channel message that's sent to participants in a journey.
Data (string) --
The message content that's passed to an AWS Lambda function or to a web hook.
NextActivity (string) --
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
TemplateName (string) --
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
ConditionalSplit (dict) --
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
Condition (dict) --
The conditions that define the paths for the activity, and the relationship between the conditions.
Conditions (list) --
The conditions to evaluate for the activity.
(dict) --
Specifies a condition to evaluate for an activity in a journey.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Operator (string) --
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
EvaluationWaitTime (dict) --
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
FalseActivity (string) --
The unique identifier for the activity to perform if the conditions aren't met.
TrueActivity (string) --
The unique identifier for the activity to perform if the conditions are met.
Description (string) --
The custom description of the activity.
EMAIL (dict) --
The settings for an email activity. This type of activity sends an email message to participants.
MessageConfig (dict) --
Specifies the sender address for an email message that's sent to participants in the journey.
FromAddress (string) --
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Holdout (dict) --
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the holdout activity.
Percentage (integer) --
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
MultiCondition (dict) --
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
(dict) --
Specifies a condition to evaluate for an activity path in a journey.
Condition (dict) --
The condition to evaluate for the activity path.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
DefaultActivity (string) --
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
EvaluationWaitTime (dict) --
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
PUSH (dict) --
The settings for a push notification activity. This type of activity sends a push notification to participants.
MessageConfig (dict) --
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
TimeToLive (string) --
The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
RandomSplit (dict) --
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
(dict) --
Specifies the settings for a path in a random split activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
Percentage (integer) --
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
SMS (dict) --
The settings for an SMS activity. This type of activity sends a text message to participants.
MessageConfig (dict) --
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Wait (dict) --
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the wait activity.
WaitTime (dict) --
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
ContactCenter (dict) --
The settings for a connect activity. This type of activity initiates a contact center call to participants.
NextActivity (string) --
The unique identifier for the next activity to perform after the this activity.
ApplicationId (string) --
The unique identifier for the application that the journey applies to.
CreationDate (string) --
The date, in ISO 8601 format, when the journey was created.
Id (string) --
The unique identifier for the journey.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the journey was last modified.
Limits (dict) --
The messaging and entry limits for the journey.
DailyCap (integer) --
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
EndpointReentryCap (integer) --
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
MessagesPerSecond (integer) --
The maximum number of messages that the journey can send each second.
EndpointReentryInterval (string) --
Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.
LocalTime (boolean) --
Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
Name (string) --
The name of the journey.
QuietTime (dict) --
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
RefreshFrequency (string) --
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Schedule (dict) --
The schedule settings for the journey.
EndTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey ended or will end.
StartTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey began or will begin.
Timezone (string) --
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
StartActivity (string) --
The unique identifier for the first activity in the journey.
StartCondition (dict) --
The segment that defines which users are participants in the journey.
Description (string) --
The custom description of the condition.
EventStartCondition (dict) --
Specifies the settings for an event that causes a journey activity to start.
EventFilter (dict) --
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Dimensions (dict) --
The dimensions for the event filter to use for the campaign or the journey activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
SegmentId (string) --
SegmentStartCondition (dict) --
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
State (string) --
The current status of the journey. Possible values are:
tags (dict) --
This object is not used or supported.
WaitForQuietTime (boolean) --
Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
RefreshOnSegmentUpdate (boolean) --
Specifies whether a journey should be refreshed on segment update.
JourneyChannelSettings (dict) --
The channel-specific configurations for the journey.
ConnectCampaignArn (string) --
Amazon Resource Name (ARN) of the Connect Campaign.
ConnectCampaignExecutionRoleArn (string) --
IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
SendingSchedule (boolean) --
Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)
OpenHours (dict) --
The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
EMAIL (dict) --
Rules for Email Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
SMS (dict) --
Rules for SMS Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
PUSH (dict) --
Rules for Push Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
VOICE (dict) --
Rules for Voice Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
CUSTOM (dict) --
Rules for Custom Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
ClosedDays (dict) --
The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.
EMAIL (list) --
Rules for Email Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
SMS (list) --
Rules for SMS Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
PUSH (list) --
Rules for Push Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
VOICE (list) --
Rules for Voice Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
CUSTOM (list) --
Rules for Custom Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptioncreate_push_template(**kwargs)¶Creates a message template for messages that are sent through a push notification channel.
See also: AWS API Documentation
Request Syntax
response = client.create_push_template(
PushNotificationTemplateRequest={
'ADM': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'APNS': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'Baidu': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'Default': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'DefaultSubstitutions': 'string',
'GCM': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'RecommenderId': 'string',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string'
},
TemplateName='string'
)
[REQUIRED]
Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.
The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
The message body to use in a push notification that's based on the message template.
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
The URL of an image to display in a push notification that's based on the message template.
The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
The message body to use in push notifications that are based on the message template.
The URL of an image or video to display in push notifications that are based on the message template.
The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.
The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
The message body to use in a push notification that's based on the message template.
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
The URL of an image to display in a push notification that's based on the message template.
The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
The default message template to use for push notification channels.
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
The message body to use in push notifications that are based on the message template.
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
The message body to use in a push notification that's based on the message template.
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
The URL of an image to display in a push notification that's based on the message template.
The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
A custom description of the message template.
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'CreateTemplateMessageBody': {
'Arn': 'string',
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
CreateTemplateMessageBody (dict) --
Provides information about a request to create a message template.
Arn (string) --
The Amazon Resource Name (ARN) of the message template that was created.
Message (string) --
The message that's returned from the API for the request to create the message template.
RequestID (string) --
The unique identifier for the request to create the message template.
Exceptions
Pinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionPinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.ForbiddenExceptioncreate_recommender_configuration(**kwargs)¶Creates an Amazon Pinpoint configuration for a recommender model.
See also: AWS API Documentation
Request Syntax
response = client.create_recommender_configuration(
CreateRecommenderConfiguration={
'Attributes': {
'string': 'string'
},
'Description': 'string',
'Name': 'string',
'RecommendationProviderIdType': 'string',
'RecommendationProviderRoleArn': 'string',
'RecommendationProviderUri': 'string',
'RecommendationTransformerUri': 'string',
'RecommendationsDisplayName': 'string',
'RecommendationsPerMessage': 123
}
)
[REQUIRED]
Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:
This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.
A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.
A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.
The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.
A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.
To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
{
'RecommenderConfigurationResponse': {
'Attributes': {
'string': 'string'
},
'CreationDate': 'string',
'Description': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Name': 'string',
'RecommendationProviderIdType': 'string',
'RecommendationProviderRoleArn': 'string',
'RecommendationProviderUri': 'string',
'RecommendationTransformerUri': 'string',
'RecommendationsDisplayName': 'string',
'RecommendationsPerMessage': 123
}
}
Response Structure
The request succeeded and the specified resource was created.
Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
The custom description of the configuration for the recommender model.
The unique identifier for the recommender model configuration.
The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
The custom name of the configuration for the recommender model.
The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.
The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptioncreate_segment(**kwargs)¶Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.create_segment(
ApplicationId='string',
WriteSegmentRequest={
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'tags': {
'string': 'string'
}
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.
The criteria that define the dimensions for the segment.
One or more custom attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The behavior-based criteria, such as how recently users have used your app, for the segment.
The dimension settings that are based on how recently an endpoint was active.
The duration to use when determining whether an endpoint is active or inactive.
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
The demographic-based criteria, such as device platform, for the segment.
The app version criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The channel criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device type criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device make criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device model criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device platform criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The location-based criteria, such as region or GPS coordinates, for the segment.
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The GPS location and range for the segment.
The GPS coordinates to measure distance from.
The latitude coordinate of the location.
The longitude coordinate of the location.
The range, in kilometers, from the GPS coordinates.
One or more custom metrics to use as criteria for the segment.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
One or more custom user attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The name of the segment.
The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
An array that defines the dimensions for the segment.
Specifies the dimension settings for a segment.
One or more custom attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The behavior-based criteria, such as how recently users have used your app, for the segment.
The dimension settings that are based on how recently an endpoint was active.
The duration to use when determining whether an endpoint is active or inactive.
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
The demographic-based criteria, such as device platform, for the segment.
The app version criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The channel criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device type criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device make criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device model criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device platform criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The location-based criteria, such as region or GPS coordinates, for the segment.
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The GPS location and range for the segment.
The GPS coordinates to measure distance from.
The latitude coordinate of the location.
The longitude coordinate of the location.
The range, in kilometers, from the GPS coordinates.
One or more custom metrics to use as criteria for the segment.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
One or more custom user attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
Specifies the segment identifier and version of a segment.
The unique identifier for the segment.
The version number of the segment.
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'tags': {
'string': 'string'
},
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
SegmentResponse (dict) --
Provides information about the configuration, dimension, and other settings for a segment.
ApplicationId (string) --
The unique identifier for the application that the segment is associated with.
Arn (string) --
The Amazon Resource Name (ARN) of the segment.
CreationDate (string) --
The date and time when the segment was created.
Dimensions (dict) --
The dimension settings for the segment.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Id (string) --
The unique identifier for the segment.
ImportDefinition (dict) --
The settings for the import job that's associated with the segment.
ChannelCounts (dict) --
The number of channel types in the endpoint definitions that were imported to create the segment.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Size (integer) --
The number of endpoint definitions that were imported successfully to create the segment.
LastModifiedDate (string) --
The date and time when the segment was last modified.
Name (string) --
The name of the segment.
SegmentGroups (dict) --
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
Groups (list) --
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
(dict) --
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Dimensions (list) --
An array that defines the dimensions for the segment.
(dict) --
Specifies the dimension settings for a segment.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
SourceSegments (list) --
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
(dict) --
Specifies the segment identifier and version of a segment.
Id (string) --
The unique identifier for the segment.
Version (integer) --
The version number of the segment.
SourceType (string) --
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Type (string) --
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Include (string) --
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
SegmentType (string) --
The segment type. Valid values are:
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
Version (integer) --
The version number of the segment.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptioncreate_sms_template(**kwargs)¶Creates a message template for messages that are sent through the SMS channel.
See also: AWS API Documentation
Request Syntax
response = client.create_sms_template(
SMSTemplateRequest={
'Body': 'string',
'DefaultSubstitutions': 'string',
'RecommenderId': 'string',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string'
},
TemplateName='string'
)
[REQUIRED]
Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
The message body to use in text messages that are based on the message template.
A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
A custom description of the message template.
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
dict
Response Syntax
{
'CreateTemplateMessageBody': {
'Arn': 'string',
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
CreateTemplateMessageBody (dict) --
Provides information about a request to create a message template.
Arn (string) --
The Amazon Resource Name (ARN) of the message template that was created.
Message (string) --
The message that's returned from the API for the request to create the message template.
RequestID (string) --
The unique identifier for the request to create the message template.
Exceptions
Pinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionPinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.ForbiddenExceptioncreate_voice_template(**kwargs)¶Creates a message template for messages that are sent through the voice channel.
See also: AWS API Documentation
Request Syntax
response = client.create_voice_template(
TemplateName='string',
VoiceTemplateRequest={
'Body': 'string',
'DefaultSubstitutions': 'string',
'LanguageCode': 'string',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string',
'VoiceId': 'string'
}
)
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
[REQUIRED]
Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.
The text of the script to use in messages that are based on the message template, in plain text format.
A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide .
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
A custom description of the message template.
The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide .
dict
Response Syntax
{
'CreateTemplateMessageBody': {
'Arn': 'string',
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request succeeded and the specified resource was created.
CreateTemplateMessageBody (dict) --
Provides information about a request to create a message template.
Arn (string) --
The Amazon Resource Name (ARN) of the message template that was created.
Message (string) --
The message that's returned from the API for the request to create the message template.
RequestID (string) --
The unique identifier for the request to create the message template.
Exceptions
Pinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionPinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.ForbiddenExceptiondelete_adm_channel(**kwargs)¶Disables the ADM channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_adm_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'ADMChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
The unique identifier for the application that the ADM channel applies to.
The date and time when the ADM channel was enabled.
Specifies whether the ADM channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.
Specifies whether the ADM channel is archived.
The user who last modified the ADM channel.
The date and time when the ADM channel was last modified.
The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.
The current version of the ADM channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_apns_channel(**kwargs)¶Disables the APNs channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_apns_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
The unique identifier for the application that the APNs channel applies to.
The date and time when the APNs channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
Specifies whether the APNs channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.
Specifies whether the APNs channel is archived.
The user who last modified the APNs channel.
The date and time when the APNs channel was last modified.
The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.
The current version of the APNs channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_apns_sandbox_channel(**kwargs)¶Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_apns_sandbox_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSSandboxChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
The unique identifier for the application that the APNs sandbox channel applies to.
The date and time when the APNs sandbox channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
Specifies whether the APNs sandbox channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.
Specifies whether the APNs sandbox channel is archived.
The user who last modified the APNs sandbox channel.
The date and time when the APNs sandbox channel was last modified.
The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.
The current version of the APNs sandbox channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_apns_voip_channel(**kwargs)¶Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_apns_voip_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSVoipChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
The unique identifier for the application that the APNs VoIP channel applies to.
The date and time when the APNs VoIP channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
Specifies whether the APNs VoIP channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
Specifies whether the APNs VoIP channel is archived.
The user who last modified the APNs VoIP channel.
The date and time when the APNs VoIP channel was last modified.
The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.
The current version of the APNs VoIP channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_apns_voip_sandbox_channel(**kwargs)¶Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_apns_voip_sandbox_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSVoipSandboxChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
The unique identifier for the application that the APNs VoIP sandbox channel applies to.
The date and time when the APNs VoIP sandbox channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
Specifies whether the APNs VoIP sandbox channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.
Specifies whether the APNs VoIP sandbox channel is archived.
The user who last modified the APNs VoIP sandbox channel.
The date and time when the APNs VoIP sandbox channel was last modified.
The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
The current version of the APNs VoIP sandbox channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_app(**kwargs)¶Deletes an application.
See also: AWS API Documentation
Request Syntax
response = client.delete_app(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'ApplicationResponse': {
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'tags': {
'string': 'string'
},
'CreationDate': 'string'
}
}
Response Structure
The request succeeded.
Provides information about an application.
The Amazon Resource Name (ARN) of the application.
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.
The date and time when the Application was created.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_baidu_channel(**kwargs)¶Disables the Baidu channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_baidu_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'BaiduChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Credential': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
The unique identifier for the application that the Baidu channel applies to.
The date and time when the Baidu channel was enabled.
The API key that you received from the Baidu Cloud Push service to communicate with the service.
Specifies whether the Baidu channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.
Specifies whether the Baidu channel is archived.
The user who last modified the Baidu channel.
The date and time when the Baidu channel was last modified.
The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
The current version of the Baidu channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_campaign(**kwargs)¶Deletes a campaign from an application.
See also: AWS API Documentation
Request Syntax
response = client.delete_campaign(
ApplicationId='string',
CampaignId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the campaign.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123,
'Session': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123,
'Priority': 123
}
}
Response Structure
(dict) --
The request succeeded.
CampaignResponse (dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
InAppMessage (dict) --
The in-app message configuration.
Body (string) --
The message body of the notification, the email body or the text message.
Content (list) --
In-app message content.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CustomConfig (dict) --
Custom config to be sent to client.
Layout (string) --
In-app message layout.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The current status of the treatment.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
TemplateConfiguration (dict) --
The message template to use for the treatment.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
Session (integer) --
The maximum total number of messages that the campaign can send per user session.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
InAppMessage (dict) --
The in-app message configuration.
Body (string) --
The message body of the notification, the email body or the text message.
Content (list) --
In-app message content.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CustomConfig (dict) --
Custom config to be sent to client.
Layout (string) --
In-app message layout.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
TemplateConfiguration (dict) --
The message template that’s used for the campaign.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the default treatment for the campaign.
TreatmentName (string) --
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
Priority (integer) --
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_email_channel(**kwargs)¶Disables the email channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_email_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'EmailChannelResponse': {
'ApplicationId': 'string',
'ConfigurationSet': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'FromAddress': 'string',
'HasCredential': True|False,
'Id': 'string',
'Identity': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'MessagesPerSecond': 123,
'Platform': 'string',
'RoleArn': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the email channel for an application.
The unique identifier for the application that the email channel applies to.
The Amazon SES configuration set that's applied to messages that are sent through the channel.
The date and time, in ISO 8601 format, when the email channel was enabled.
Specifies whether the email channel is enabled for the application.
The verified email address that email is sent from when you send email through the channel.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.
Specifies whether the email channel is archived.
The user who last modified the email channel.
The date and time, in ISO 8601 format, when the email channel was last modified.
The maximum number of emails that can be sent through the channel each second.
The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
The current version of the email channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_email_template(**kwargs)¶Deletes a message template for messages that were sent through the email channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_email_template(
TemplateName='string',
Version='string'
)
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_endpoint(**kwargs)¶Deletes an endpoint from an application.
See also: AWS API Documentation
Request Syntax
response = client.delete_endpoint(
ApplicationId='string',
EndpointId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the endpoint.
dict
Response Syntax
{
'EndpointResponse': {
'Address': 'string',
'ApplicationId': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
'CohortId': 'string',
'CreationDate': 'string',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Id': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
EndpointResponse (dict) --
Provides information about the channel type and other settings for an endpoint.
Address (string) --
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
ApplicationId (string) --
The unique identifier for the application that's associated with the endpoint.
Attributes (dict) --
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments.
ChannelType (string) --
The channel that's used when sending messages or push notifications to the endpoint.
CohortId (string) --
A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
CreationDate (string) --
The date and time, in ISO 8601 format, when the endpoint was created.
Demographic (dict) --
The demographic information for the endpoint, such as the time zone and platform.
AppVersion (string) --
The version of the app that's associated with the endpoint.
Locale (string) --
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
Make (string) --
The manufacturer of the endpoint device, such as apple or samsung.
Model (string) --
The model name or number of the endpoint device, such as iPhone or SM-G900F.
ModelVersion (string) --
The model version of the endpoint device.
Platform (string) --
The platform of the endpoint device, such as ios.
PlatformVersion (string) --
The platform version of the endpoint device.
Timezone (string) --
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
EffectiveDate (string) --
The date and time, in ISO 8601 format, when the endpoint was last updated.
EndpointStatus (string) --
Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
Id (string) --
The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
Location (dict) --
The geographic information for the endpoint.
City (string) --
The name of the city where the endpoint is located.
Country (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
Latitude (float) --
The latitude coordinate of the endpoint location, rounded to one decimal place.
Longitude (float) --
The longitude coordinate of the endpoint location, rounded to one decimal place.
PostalCode (string) --
The postal or ZIP code for the area where the endpoint is located.
Region (string) --
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
OptOut (string) --
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
RequestId (string) --
The unique identifier for the most recent request to update the endpoint.
User (dict) --
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
UserAttributes (dict) --
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
UserId (string) --
The unique identifier for the user.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_event_stream(**kwargs)¶Deletes the event stream for an application.
See also: AWS API Documentation
Request Syntax
response = client.delete_event_stream(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'EventStream': {
'ApplicationId': 'string',
'DestinationStreamArn': 'string',
'ExternalId': 'string',
'LastModifiedDate': 'string',
'LastUpdatedBy': 'string',
'RoleArn': 'string'
}
}
Response Structure
The request succeeded.
Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.
The unique identifier for the application to publish event data for.
The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
The date, in ISO 8601 format, when the event stream was last modified.
The IAM user who last modified the event stream.
The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_gcm_channel(**kwargs)¶Disables the GCM channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_gcm_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'GCMChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Credential': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
The unique identifier for the application that the GCM channel applies to.
The date and time when the GCM channel was enabled.
The Web API Key, also referred to as an API_KEY or server key , that you received from Google to communicate with Google services.
Specifies whether the GCM channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
Specifies whether the GCM channel is archived.
The user who last modified the GCM channel.
The date and time when the GCM channel was last modified.
The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.
The current version of the GCM channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_in_app_template(**kwargs)¶Deletes a message template for messages sent using the in-app message channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_in_app_template(
TemplateName='string',
Version='string'
)
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_journey(**kwargs)¶Deletes a journey from an application.
See also: AWS API Documentation
Request Syntax
response = client.delete_journey(
ApplicationId='string',
JourneyId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the journey.
dict
Response Syntax
{
'JourneyResponse': {
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'ContactCenter': {
'NextActivity': 'string'
}
}
},
'ApplicationId': 'string',
'CreationDate': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123,
'EndpointReentryInterval': 'string'
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED'|'PAUSED',
'tags': {
'string': 'string'
},
'WaitForQuietTime': True|False,
'RefreshOnSegmentUpdate': True|False,
'JourneyChannelSettings': {
'ConnectCampaignArn': 'string',
'ConnectCampaignExecutionRoleArn': 'string'
},
'SendingSchedule': True|False,
'OpenHours': {
'EMAIL': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'SMS': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'PUSH': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'VOICE': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'CUSTOM': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
}
},
'ClosedDays': {
'EMAIL': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'SMS': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'PUSH': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'VOICE': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'CUSTOM': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
]
}
}
}
Response Structure
(dict) --
The request succeeded.
JourneyResponse (dict) --
Provides information about the status, configuration, and other settings for a journey.
Activities (dict) --
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
(string) --
(dict) --
Specifies the configuration and other settings for an activity in a journey.
CUSTOM (dict) --
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
MessageConfig (dict) --
Specifies the message data included in a custom channel message that's sent to participants in a journey.
Data (string) --
The message content that's passed to an AWS Lambda function or to a web hook.
NextActivity (string) --
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
TemplateName (string) --
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
ConditionalSplit (dict) --
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
Condition (dict) --
The conditions that define the paths for the activity, and the relationship between the conditions.
Conditions (list) --
The conditions to evaluate for the activity.
(dict) --
Specifies a condition to evaluate for an activity in a journey.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Operator (string) --
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
EvaluationWaitTime (dict) --
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
FalseActivity (string) --
The unique identifier for the activity to perform if the conditions aren't met.
TrueActivity (string) --
The unique identifier for the activity to perform if the conditions are met.
Description (string) --
The custom description of the activity.
EMAIL (dict) --
The settings for an email activity. This type of activity sends an email message to participants.
MessageConfig (dict) --
Specifies the sender address for an email message that's sent to participants in the journey.
FromAddress (string) --
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Holdout (dict) --
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the holdout activity.
Percentage (integer) --
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
MultiCondition (dict) --
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
(dict) --
Specifies a condition to evaluate for an activity path in a journey.
Condition (dict) --
The condition to evaluate for the activity path.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
DefaultActivity (string) --
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
EvaluationWaitTime (dict) --
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
PUSH (dict) --
The settings for a push notification activity. This type of activity sends a push notification to participants.
MessageConfig (dict) --
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
TimeToLive (string) --
The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
RandomSplit (dict) --
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
(dict) --
Specifies the settings for a path in a random split activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
Percentage (integer) --
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
SMS (dict) --
The settings for an SMS activity. This type of activity sends a text message to participants.
MessageConfig (dict) --
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Wait (dict) --
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the wait activity.
WaitTime (dict) --
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
ContactCenter (dict) --
The settings for a connect activity. This type of activity initiates a contact center call to participants.
NextActivity (string) --
The unique identifier for the next activity to perform after the this activity.
ApplicationId (string) --
The unique identifier for the application that the journey applies to.
CreationDate (string) --
The date, in ISO 8601 format, when the journey was created.
Id (string) --
The unique identifier for the journey.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the journey was last modified.
Limits (dict) --
The messaging and entry limits for the journey.
DailyCap (integer) --
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
EndpointReentryCap (integer) --
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
MessagesPerSecond (integer) --
The maximum number of messages that the journey can send each second.
EndpointReentryInterval (string) --
Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.
LocalTime (boolean) --
Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
Name (string) --
The name of the journey.
QuietTime (dict) --
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
RefreshFrequency (string) --
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Schedule (dict) --
The schedule settings for the journey.
EndTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey ended or will end.
StartTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey began or will begin.
Timezone (string) --
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
StartActivity (string) --
The unique identifier for the first activity in the journey.
StartCondition (dict) --
The segment that defines which users are participants in the journey.
Description (string) --
The custom description of the condition.
EventStartCondition (dict) --
Specifies the settings for an event that causes a journey activity to start.
EventFilter (dict) --
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Dimensions (dict) --
The dimensions for the event filter to use for the campaign or the journey activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
SegmentId (string) --
SegmentStartCondition (dict) --
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
State (string) --
The current status of the journey. Possible values are:
tags (dict) --
This object is not used or supported.
WaitForQuietTime (boolean) --
Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
RefreshOnSegmentUpdate (boolean) --
Specifies whether a journey should be refreshed on segment update.
JourneyChannelSettings (dict) --
The channel-specific configurations for the journey.
ConnectCampaignArn (string) --
Amazon Resource Name (ARN) of the Connect Campaign.
ConnectCampaignExecutionRoleArn (string) --
IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
SendingSchedule (boolean) --
Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)
OpenHours (dict) --
The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
EMAIL (dict) --
Rules for Email Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
SMS (dict) --
Rules for SMS Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
PUSH (dict) --
Rules for Push Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
VOICE (dict) --
Rules for Voice Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
CUSTOM (dict) --
Rules for Custom Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
ClosedDays (dict) --
The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.
EMAIL (list) --
Rules for Email Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
SMS (list) --
Rules for SMS Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
PUSH (list) --
Rules for Push Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
VOICE (list) --
Rules for Voice Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
CUSTOM (list) --
Rules for Custom Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_push_template(**kwargs)¶Deletes a message template for messages that were sent through a push notification channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_push_template(
TemplateName='string',
Version='string'
)
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_recommender_configuration(**kwargs)¶Deletes an Amazon Pinpoint configuration for a recommender model.
See also: AWS API Documentation
Request Syntax
response = client.delete_recommender_configuration(
RecommenderId='string'
)
[REQUIRED]
The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
{
'RecommenderConfigurationResponse': {
'Attributes': {
'string': 'string'
},
'CreationDate': 'string',
'Description': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Name': 'string',
'RecommendationProviderIdType': 'string',
'RecommendationProviderRoleArn': 'string',
'RecommendationProviderUri': 'string',
'RecommendationTransformerUri': 'string',
'RecommendationsDisplayName': 'string',
'RecommendationsPerMessage': 123
}
}
Response Structure
The request succeeded.
Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
The custom description of the configuration for the recommender model.
The unique identifier for the recommender model configuration.
The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
The custom name of the configuration for the recommender model.
The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.
The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_segment(**kwargs)¶Deletes a segment from an application.
See also: AWS API Documentation
Request Syntax
response = client.delete_segment(
ApplicationId='string',
SegmentId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the segment.
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'tags': {
'string': 'string'
},
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
SegmentResponse (dict) --
Provides information about the configuration, dimension, and other settings for a segment.
ApplicationId (string) --
The unique identifier for the application that the segment is associated with.
Arn (string) --
The Amazon Resource Name (ARN) of the segment.
CreationDate (string) --
The date and time when the segment was created.
Dimensions (dict) --
The dimension settings for the segment.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Id (string) --
The unique identifier for the segment.
ImportDefinition (dict) --
The settings for the import job that's associated with the segment.
ChannelCounts (dict) --
The number of channel types in the endpoint definitions that were imported to create the segment.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Size (integer) --
The number of endpoint definitions that were imported successfully to create the segment.
LastModifiedDate (string) --
The date and time when the segment was last modified.
Name (string) --
The name of the segment.
SegmentGroups (dict) --
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
Groups (list) --
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
(dict) --
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Dimensions (list) --
An array that defines the dimensions for the segment.
(dict) --
Specifies the dimension settings for a segment.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
SourceSegments (list) --
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
(dict) --
Specifies the segment identifier and version of a segment.
Id (string) --
The unique identifier for the segment.
Version (integer) --
The version number of the segment.
SourceType (string) --
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Type (string) --
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Include (string) --
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
SegmentType (string) --
The segment type. Valid values are:
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
Version (integer) --
The version number of the segment.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_sms_channel(**kwargs)¶Disables the SMS channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_sms_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'SMSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'PromotionalMessagesPerSecond': 123,
'SenderId': 'string',
'ShortCode': 'string',
'TransactionalMessagesPerSecond': 123,
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the SMS channel for an application.
The unique identifier for the application that the SMS channel applies to.
The date and time, in ISO 8601 format, when the SMS channel was enabled.
Specifies whether the SMS channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
Specifies whether the SMS channel is archived.
The user who last modified the SMS channel.
The date and time, in ISO 8601 format, when the SMS channel was last modified.
The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
The maximum number of promotional messages that you can send through the SMS channel each second.
The identity that displays on recipients' devices when they receive messages from the SMS channel.
The registered short code to use when you send messages through the SMS channel.
The maximum number of transactional messages that you can send through the SMS channel each second.
The current version of the SMS channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_sms_template(**kwargs)¶Deletes a message template for messages that were sent through the SMS channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_sms_template(
TemplateName='string',
Version='string'
)
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_user_endpoints(**kwargs)¶Deletes all the endpoints that are associated with a specific user ID.
See also: AWS API Documentation
Request Syntax
response = client.delete_user_endpoints(
ApplicationId='string',
UserId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the user.
dict
Response Syntax
{
'EndpointsResponse': {
'Item': [
{
'Address': 'string',
'ApplicationId': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
'CohortId': 'string',
'CreationDate': 'string',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Id': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
},
]
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
EndpointsResponse (dict) --
Provides information about all the endpoints that are associated with a user ID.
Item (list) --
An array of responses, one for each endpoint that's associated with the user ID.
(dict) --
Provides information about the channel type and other settings for an endpoint.
Address (string) --
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
ApplicationId (string) --
The unique identifier for the application that's associated with the endpoint.
Attributes (dict) --
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments.
ChannelType (string) --
The channel that's used when sending messages or push notifications to the endpoint.
CohortId (string) --
A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
CreationDate (string) --
The date and time, in ISO 8601 format, when the endpoint was created.
Demographic (dict) --
The demographic information for the endpoint, such as the time zone and platform.
AppVersion (string) --
The version of the app that's associated with the endpoint.
Locale (string) --
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
Make (string) --
The manufacturer of the endpoint device, such as apple or samsung.
Model (string) --
The model name or number of the endpoint device, such as iPhone or SM-G900F.
ModelVersion (string) --
The model version of the endpoint device.
Platform (string) --
The platform of the endpoint device, such as ios.
PlatformVersion (string) --
The platform version of the endpoint device.
Timezone (string) --
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
EffectiveDate (string) --
The date and time, in ISO 8601 format, when the endpoint was last updated.
EndpointStatus (string) --
Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
Id (string) --
The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
Location (dict) --
The geographic information for the endpoint.
City (string) --
The name of the city where the endpoint is located.
Country (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
Latitude (float) --
The latitude coordinate of the endpoint location, rounded to one decimal place.
Longitude (float) --
The longitude coordinate of the endpoint location, rounded to one decimal place.
PostalCode (string) --
The postal or ZIP code for the area where the endpoint is located.
Region (string) --
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
OptOut (string) --
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
RequestId (string) --
The unique identifier for the most recent request to update the endpoint.
User (dict) --
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
UserAttributes (dict) --
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
UserId (string) --
The unique identifier for the user.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_voice_channel(**kwargs)¶Disables the voice channel for an application and deletes any existing settings for the channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_voice_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'VoiceChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the voice channel for an application.
The unique identifier for the application that the voice channel applies to.
The date and time, in ISO 8601 format, when the voice channel was enabled.
Specifies whether the voice channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
Specifies whether the voice channel is archived.
The user who last modified the voice channel.
The date and time, in ISO 8601 format, when the voice channel was last modified.
The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.
The current version of the voice channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiondelete_voice_template(**kwargs)¶Deletes a message template for messages that were sent through the voice channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_voice_template(
TemplateName='string',
Version='string'
)
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_adm_channel(**kwargs)¶Retrieves information about the status and settings of the ADM channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_adm_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'ADMChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
The unique identifier for the application that the ADM channel applies to.
The date and time when the ADM channel was enabled.
Specifies whether the ADM channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.
Specifies whether the ADM channel is archived.
The user who last modified the ADM channel.
The date and time when the ADM channel was last modified.
The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.
The current version of the ADM channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_apns_channel(**kwargs)¶Retrieves information about the status and settings of the APNs channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_apns_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
The unique identifier for the application that the APNs channel applies to.
The date and time when the APNs channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
Specifies whether the APNs channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.
Specifies whether the APNs channel is archived.
The user who last modified the APNs channel.
The date and time when the APNs channel was last modified.
The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.
The current version of the APNs channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_apns_sandbox_channel(**kwargs)¶Retrieves information about the status and settings of the APNs sandbox channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_apns_sandbox_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSSandboxChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
The unique identifier for the application that the APNs sandbox channel applies to.
The date and time when the APNs sandbox channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
Specifies whether the APNs sandbox channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.
Specifies whether the APNs sandbox channel is archived.
The user who last modified the APNs sandbox channel.
The date and time when the APNs sandbox channel was last modified.
The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.
The current version of the APNs sandbox channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_apns_voip_channel(**kwargs)¶Retrieves information about the status and settings of the APNs VoIP channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_apns_voip_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSVoipChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
The unique identifier for the application that the APNs VoIP channel applies to.
The date and time when the APNs VoIP channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
Specifies whether the APNs VoIP channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
Specifies whether the APNs VoIP channel is archived.
The user who last modified the APNs VoIP channel.
The date and time when the APNs VoIP channel was last modified.
The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.
The current version of the APNs VoIP channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_apns_voip_sandbox_channel(**kwargs)¶Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_apns_voip_sandbox_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'APNSVoipSandboxChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
The unique identifier for the application that the APNs VoIP sandbox channel applies to.
The date and time when the APNs VoIP sandbox channel was enabled.
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
Specifies whether the APNs VoIP sandbox channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
(Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.
Specifies whether the APNs VoIP sandbox channel is archived.
The user who last modified the APNs VoIP sandbox channel.
The date and time when the APNs VoIP sandbox channel was last modified.
The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
The current version of the APNs VoIP sandbox channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_app(**kwargs)¶Retrieves information about an application.
See also: AWS API Documentation
Request Syntax
response = client.get_app(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'ApplicationResponse': {
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'tags': {
'string': 'string'
},
'CreationDate': 'string'
}
}
Response Structure
The request succeeded.
Provides information about an application.
The Amazon Resource Name (ARN) of the application.
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.
The date and time when the Application was created.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_application_date_range_kpi(**kwargs)¶Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
See also: AWS API Documentation
Request Syntax
response = client.get_application_date_range_kpi(
ApplicationId='string',
EndTime=datetime(2015, 1, 1),
KpiName='string',
NextToken='string',
PageSize='string',
StartTime=datetime(2015, 1, 1)
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The name of the metric, also referred to as a key performance indicator (KPI) , to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide .
dict
Response Syntax
{
'ApplicationDateRangeKpiResponse': {
'ApplicationId': 'string',
'EndTime': datetime(2015, 1, 1),
'KpiName': 'string',
'KpiResult': {
'Rows': [
{
'GroupedBys': [
{
'Key': 'string',
'Type': 'string',
'Value': 'string'
},
],
'Values': [
{
'Key': 'string',
'Type': 'string',
'Value': 'string'
},
]
},
]
},
'NextToken': 'string',
'StartTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
The request succeeded.
ApplicationDateRangeKpiResponse (dict) --
Provides the results of a query that retrieved the data for a standard metric that applies to an application, and provides information about that query.
ApplicationId (string) --
The unique identifier for the application that the metric applies to.
EndTime (datetime) --
The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
KpiName (string) --
The name of the metric, also referred to as a key performance indicator (KPI) , that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide .
KpiResult (dict) --
An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
Rows (list) --
An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
(dict) --
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
GroupedBys (list) --
An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.
(dict) --
Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.
Key (string) --
The friendly name of the metric whose value is specified by the Value property.
Type (string) --
The data type of the value specified by the Value property.
Value (string) --
In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).
Values (list) --
An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.
(dict) --
Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.
Key (string) --
The friendly name of the metric whose value is specified by the Value property.
Type (string) --
The data type of the value specified by the Value property.
Value (string) --
In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page.
StartTime (datetime) --
The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_application_settings(**kwargs)¶Retrieves information about the settings for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_application_settings(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'ApplicationSettingsResource': {
'ApplicationId': 'string',
'CampaignHook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123,
'Session': 123
},
'QuietTime': {
'End': 'string',
'Start': 'string'
}
}
}
Response Structure
The request succeeded.
Provides information about an application, including the default settings for an application.
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
The date and time, in ISO 8601 format, when the application's settings were last modified.
The default sending limits for campaigns in the application.
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
The maximum total number of messages that the campaign can send per user session.
The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_apps(**kwargs)¶Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
See also: AWS API Documentation
Request Syntax
response = client.get_apps(
PageSize='string',
Token='string'
)
dict
Response Syntax
{
'ApplicationsResponse': {
'Item': [
{
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'tags': {
'string': 'string'
},
'CreationDate': 'string'
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ApplicationsResponse (dict) --
Provides information about all of your applications.
Item (list) --
An array of responses, one for each application that was returned.
(dict) --
Provides information about an application.
Arn (string) --
The Amazon Resource Name (ARN) of the application.
Id (string) --
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Name (string) --
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.
CreationDate (string) --
The date and time when the Application was created.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_baidu_channel(**kwargs)¶Retrieves information about the status and settings of the Baidu channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_baidu_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'BaiduChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Credential': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
The unique identifier for the application that the Baidu channel applies to.
The date and time when the Baidu channel was enabled.
The API key that you received from the Baidu Cloud Push service to communicate with the service.
Specifies whether the Baidu channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.
Specifies whether the Baidu channel is archived.
The user who last modified the Baidu channel.
The date and time when the Baidu channel was last modified.
The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
The current version of the Baidu channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_campaign(**kwargs)¶Retrieves information about the status, configuration, and other settings for a campaign.
See also: AWS API Documentation
Request Syntax
response = client.get_campaign(
ApplicationId='string',
CampaignId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the campaign.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123,
'Session': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123,
'Priority': 123
}
}
Response Structure
(dict) --
The request succeeded.
CampaignResponse (dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
InAppMessage (dict) --
The in-app message configuration.
Body (string) --
The message body of the notification, the email body or the text message.
Content (list) --
In-app message content.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CustomConfig (dict) --
Custom config to be sent to client.
Layout (string) --
In-app message layout.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The current status of the treatment.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
TemplateConfiguration (dict) --
The message template to use for the treatment.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
Session (integer) --
The maximum total number of messages that the campaign can send per user session.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
InAppMessage (dict) --
The in-app message configuration.
Body (string) --
The message body of the notification, the email body or the text message.
Content (list) --
In-app message content.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CustomConfig (dict) --
Custom config to be sent to client.
Layout (string) --
In-app message layout.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
TemplateConfiguration (dict) --
The message template that’s used for the campaign.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the default treatment for the campaign.
TreatmentName (string) --
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
Priority (integer) --
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_campaign_activities(**kwargs)¶Retrieves information about all the activities for a campaign.
See also: AWS API Documentation
Request Syntax
response = client.get_campaign_activities(
ApplicationId='string',
CampaignId='string',
PageSize='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the campaign.
dict
Response Syntax
{
'ActivitiesResponse': {
'Item': [
{
'ApplicationId': 'string',
'CampaignId': 'string',
'End': 'string',
'Id': 'string',
'Result': 'string',
'ScheduledStart': 'string',
'Start': 'string',
'State': 'string',
'SuccessfulEndpointCount': 123,
'TimezonesCompletedCount': 123,
'TimezonesTotalCount': 123,
'TotalEndpointCount': 123,
'TreatmentId': 'string'
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ActivitiesResponse (dict) --
Provides information about the activities that were performed by a campaign.
Item (list) --
An array of responses, one for each activity that was performed by the campaign.
(dict) --
Provides information about an activity that was performed by a campaign.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
CampaignId (string) --
The unique identifier for the campaign that the activity applies to.
End (string) --
The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
Id (string) --
The unique identifier for the activity.
Result (string) --
Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
ScheduledStart (string) --
The scheduled start time, in ISO 8601 format, for the activity.
Start (string) --
The actual start time, in ISO 8601 format, of the activity.
State (string) --
The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
SuccessfulEndpointCount (integer) --
The total number of endpoints that the campaign successfully delivered messages to.
TimezonesCompletedCount (integer) --
The total number of time zones that were completed.
TimezonesTotalCount (integer) --
The total number of unique time zones that are in the segment for the campaign.
TotalEndpointCount (integer) --
The total number of endpoints that the campaign attempted to deliver messages to.
TreatmentId (string) --
The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_campaign_date_range_kpi(**kwargs)¶Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
See also: AWS API Documentation
Request Syntax
response = client.get_campaign_date_range_kpi(
ApplicationId='string',
CampaignId='string',
EndTime=datetime(2015, 1, 1),
KpiName='string',
NextToken='string',
PageSize='string',
StartTime=datetime(2015, 1, 1)
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the campaign.
[REQUIRED]
The name of the metric, also referred to as a key performance indicator (KPI) , to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide .
dict
Response Syntax
{
'CampaignDateRangeKpiResponse': {
'ApplicationId': 'string',
'CampaignId': 'string',
'EndTime': datetime(2015, 1, 1),
'KpiName': 'string',
'KpiResult': {
'Rows': [
{
'GroupedBys': [
{
'Key': 'string',
'Type': 'string',
'Value': 'string'
},
],
'Values': [
{
'Key': 'string',
'Type': 'string',
'Value': 'string'
},
]
},
]
},
'NextToken': 'string',
'StartTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
The request succeeded.
CampaignDateRangeKpiResponse (dict) --
Provides the results of a query that retrieved the data for a standard metric that applies to a campaign, and provides information about that query.
ApplicationId (string) --
The unique identifier for the application that the metric applies to.
CampaignId (string) --
The unique identifier for the campaign that the metric applies to.
EndTime (datetime) --
The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
KpiName (string) --
The name of the metric, also referred to as a key performance indicator (KPI) , that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide .
KpiResult (dict) --
An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
Rows (list) --
An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
(dict) --
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
GroupedBys (list) --
An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.
(dict) --
Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.
Key (string) --
The friendly name of the metric whose value is specified by the Value property.
Type (string) --
The data type of the value specified by the Value property.
Value (string) --
In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).
Values (list) --
An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.
(dict) --
Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.
Key (string) --
The friendly name of the metric whose value is specified by the Value property.
Type (string) --
The data type of the value specified by the Value property.
Value (string) --
In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.
StartTime (datetime) --
The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_campaign_version(**kwargs)¶Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
See also: AWS API Documentation
Request Syntax
response = client.get_campaign_version(
ApplicationId='string',
CampaignId='string',
Version='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the campaign.
[REQUIRED]
The unique version number (Version property) for the campaign version.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123,
'Session': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123,
'Priority': 123
}
}
Response Structure
(dict) --
The request succeeded.
CampaignResponse (dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
InAppMessage (dict) --
The in-app message configuration.
Body (string) --
The message body of the notification, the email body or the text message.
Content (list) --
In-app message content.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CustomConfig (dict) --
Custom config to be sent to client.
Layout (string) --
In-app message layout.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The current status of the treatment.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
TemplateConfiguration (dict) --
The message template to use for the treatment.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
Session (integer) --
The maximum total number of messages that the campaign can send per user session.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
InAppMessage (dict) --
The in-app message configuration.
Body (string) --
The message body of the notification, the email body or the text message.
Content (list) --
In-app message content.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CustomConfig (dict) --
Custom config to be sent to client.
Layout (string) --
In-app message layout.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
TemplateConfiguration (dict) --
The message template that’s used for the campaign.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the default treatment for the campaign.
TreatmentName (string) --
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
Priority (integer) --
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_campaign_versions(**kwargs)¶Retrieves information about the status, configuration, and other settings for all versions of a campaign.
See also: AWS API Documentation
Request Syntax
response = client.get_campaign_versions(
ApplicationId='string',
CampaignId='string',
PageSize='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the campaign.
dict
Response Syntax
{
'CampaignsResponse': {
'Item': [
{
'AdditionalTreatments': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123,
'Session': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123,
'Priority': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
CampaignsResponse (dict) --
Provides information about the configuration and other settings for all the campaigns that are associated with an application.
Item (list) --
An array of responses, one for each campaign that's associated with the application.
(dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
InAppMessage (dict) --
The in-app message configuration.
Body (string) --
The message body of the notification, the email body or the text message.
Content (list) --
In-app message content.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CustomConfig (dict) --
Custom config to be sent to client.
Layout (string) --
In-app message layout.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The current status of the treatment.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
TemplateConfiguration (dict) --
The message template to use for the treatment.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
Session (integer) --
The maximum total number of messages that the campaign can send per user session.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
InAppMessage (dict) --
The in-app message configuration.
Body (string) --
The message body of the notification, the email body or the text message.
Content (list) --
In-app message content.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CustomConfig (dict) --
Custom config to be sent to client.
Layout (string) --
In-app message layout.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
TemplateConfiguration (dict) --
The message template that’s used for the campaign.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the default treatment for the campaign.
TreatmentName (string) --
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
Priority (integer) --
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_campaigns(**kwargs)¶Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.get_campaigns(
ApplicationId='string',
PageSize='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'CampaignsResponse': {
'Item': [
{
'AdditionalTreatments': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123,
'Session': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123,
'Priority': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
CampaignsResponse (dict) --
Provides information about the configuration and other settings for all the campaigns that are associated with an application.
Item (list) --
An array of responses, one for each campaign that's associated with the application.
(dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
InAppMessage (dict) --
The in-app message configuration.
Body (string) --
The message body of the notification, the email body or the text message.
Content (list) --
In-app message content.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CustomConfig (dict) --
Custom config to be sent to client.
Layout (string) --
In-app message layout.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The current status of the treatment.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
TemplateConfiguration (dict) --
The message template to use for the treatment.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
Session (integer) --
The maximum total number of messages that the campaign can send per user session.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
InAppMessage (dict) --
The in-app message configuration.
Body (string) --
The message body of the notification, the email body or the text message.
Content (list) --
In-app message content.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CustomConfig (dict) --
Custom config to be sent to client.
Layout (string) --
In-app message layout.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
TemplateConfiguration (dict) --
The message template that’s used for the campaign.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the default treatment for the campaign.
TreatmentName (string) --
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
Priority (integer) --
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_channels(**kwargs)¶Retrieves information about the history and status of each channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_channels(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'ChannelsResponse': {
'Channels': {
'string': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Version': 123
}
}
}
}
Response Structure
The request succeeded.
Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.
A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.
Provides information about the general settings and status of a channel for an application.
The unique identifier for the application.
The date and time, in ISO 8601 format, when the channel was enabled.
Specifies whether the channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the channel. This property is retained only for backward compatibility.
Specifies whether the channel is archived.
The user who last modified the channel.
The date and time, in ISO 8601 format, when the channel was last modified.
The current version of the channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_email_channel(**kwargs)¶Retrieves information about the status and settings of the email channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_email_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'EmailChannelResponse': {
'ApplicationId': 'string',
'ConfigurationSet': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'FromAddress': 'string',
'HasCredential': True|False,
'Id': 'string',
'Identity': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'MessagesPerSecond': 123,
'Platform': 'string',
'RoleArn': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the email channel for an application.
The unique identifier for the application that the email channel applies to.
The Amazon SES configuration set that's applied to messages that are sent through the channel.
The date and time, in ISO 8601 format, when the email channel was enabled.
Specifies whether the email channel is enabled for the application.
The verified email address that email is sent from when you send email through the channel.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.
Specifies whether the email channel is archived.
The user who last modified the email channel.
The date and time, in ISO 8601 format, when the email channel was last modified.
The maximum number of emails that can be sent through the channel each second.
The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
The current version of the email channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_email_template(**kwargs)¶Retrieves the content and settings of a message template for messages that are sent through the email channel.
See also: AWS API Documentation
Request Syntax
response = client.get_email_template(
TemplateName='string',
Version='string'
)
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
dict
Response Syntax
{
'EmailTemplateResponse': {
'Arn': 'string',
'CreationDate': 'string',
'DefaultSubstitutions': 'string',
'HtmlPart': 'string',
'LastModifiedDate': 'string',
'RecommenderId': 'string',
'Subject': 'string',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string',
'TemplateName': 'string',
'TemplateType': 'EMAIL'|'SMS'|'VOICE'|'PUSH'|'INAPP',
'TextPart': 'string',
'Version': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
EmailTemplateResponse (dict) --
Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.
Arn (string) --
The Amazon Resource Name (ARN) of the message template.
CreationDate (string) --
The date, in ISO 8601 format, when the message template was created.
DefaultSubstitutions (string) --
The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
HtmlPart (string) --
The message body, in HTML format, that's used in email messages that are based on the message template.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the message template was last modified.
RecommenderId (string) --
The unique identifier for the recommender model that's used by the message template.
Subject (string) --
The subject line, or title, that's used in email messages that are based on the message template.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
TemplateDescription (string) --
The custom description of the message template.
TemplateName (string) --
The name of the message template.
TemplateType (string) --
The type of channel that the message template is designed for. For an email template, this value is EMAIL.
TextPart (string) --
The message body, in plain text format, that's used in email messages that are based on the message template.
Version (string) --
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_endpoint(**kwargs)¶Retrieves information about the settings and attributes of a specific endpoint for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_endpoint(
ApplicationId='string',
EndpointId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the endpoint.
dict
Response Syntax
{
'EndpointResponse': {
'Address': 'string',
'ApplicationId': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
'CohortId': 'string',
'CreationDate': 'string',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Id': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
}
}
Response Structure
(dict) --
The request succeeded.
EndpointResponse (dict) --
Provides information about the channel type and other settings for an endpoint.
Address (string) --
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
ApplicationId (string) --
The unique identifier for the application that's associated with the endpoint.
Attributes (dict) --
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments.
ChannelType (string) --
The channel that's used when sending messages or push notifications to the endpoint.
CohortId (string) --
A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
CreationDate (string) --
The date and time, in ISO 8601 format, when the endpoint was created.
Demographic (dict) --
The demographic information for the endpoint, such as the time zone and platform.
AppVersion (string) --
The version of the app that's associated with the endpoint.
Locale (string) --
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
Make (string) --
The manufacturer of the endpoint device, such as apple or samsung.
Model (string) --
The model name or number of the endpoint device, such as iPhone or SM-G900F.
ModelVersion (string) --
The model version of the endpoint device.
Platform (string) --
The platform of the endpoint device, such as ios.
PlatformVersion (string) --
The platform version of the endpoint device.
Timezone (string) --
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
EffectiveDate (string) --
The date and time, in ISO 8601 format, when the endpoint was last updated.
EndpointStatus (string) --
Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
Id (string) --
The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
Location (dict) --
The geographic information for the endpoint.
City (string) --
The name of the city where the endpoint is located.
Country (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
Latitude (float) --
The latitude coordinate of the endpoint location, rounded to one decimal place.
Longitude (float) --
The longitude coordinate of the endpoint location, rounded to one decimal place.
PostalCode (string) --
The postal or ZIP code for the area where the endpoint is located.
Region (string) --
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
OptOut (string) --
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
RequestId (string) --
The unique identifier for the most recent request to update the endpoint.
User (dict) --
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
UserAttributes (dict) --
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
UserId (string) --
The unique identifier for the user.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_event_stream(**kwargs)¶Retrieves information about the event stream settings for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_event_stream(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'EventStream': {
'ApplicationId': 'string',
'DestinationStreamArn': 'string',
'ExternalId': 'string',
'LastModifiedDate': 'string',
'LastUpdatedBy': 'string',
'RoleArn': 'string'
}
}
Response Structure
The request succeeded.
Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.
The unique identifier for the application to publish event data for.
The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
The date, in ISO 8601 format, when the event stream was last modified.
The IAM user who last modified the event stream.
The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_export_job(**kwargs)¶Retrieves information about the status and settings of a specific export job for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_export_job(
ApplicationId='string',
JobId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the job.
dict
Response Syntax
{
'ExportJobResponse': {
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'RoleArn': 'string',
'S3UrlPrefix': 'string',
'SegmentId': 'string',
'SegmentVersion': 123
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'PREPARING_FOR_INITIALIZATION'|'INITIALIZING'|'PROCESSING'|'PENDING_JOB'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ExportJobResponse (dict) --
Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the export job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the export job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the export job was created.
Definition (dict) --
The resource settings that apply to the export job.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.
S3UrlPrefix (string) --
The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
SegmentId (string) --
The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.
SegmentVersion (integer) --
The version of the segment that the endpoint definitions were exported from.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
Id (string) --
The unique identifier for the export job.
JobStatus (string) --
The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the export job.
Type (string) --
The job type. This value is EXPORT for export jobs.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_export_jobs(**kwargs)¶Retrieves information about the status and settings of all the export jobs for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_export_jobs(
ApplicationId='string',
PageSize='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'ExportJobsResponse': {
'Item': [
{
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'RoleArn': 'string',
'S3UrlPrefix': 'string',
'SegmentId': 'string',
'SegmentVersion': 123
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'PREPARING_FOR_INITIALIZATION'|'INITIALIZING'|'PROCESSING'|'PENDING_JOB'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ExportJobsResponse (dict) --
Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.
Item (list) --
An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).
(dict) --
Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the export job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the export job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the export job was created.
Definition (dict) --
The resource settings that apply to the export job.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.
S3UrlPrefix (string) --
The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
SegmentId (string) --
The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.
SegmentVersion (integer) --
The version of the segment that the endpoint definitions were exported from.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
Id (string) --
The unique identifier for the export job.
JobStatus (string) --
The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the export job.
Type (string) --
The job type. This value is EXPORT for export jobs.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_gcm_channel(**kwargs)¶Retrieves information about the status and settings of the GCM channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_gcm_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'GCMChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Credential': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
The unique identifier for the application that the GCM channel applies to.
The date and time when the GCM channel was enabled.
The Web API Key, also referred to as an API_KEY or server key , that you received from Google to communicate with Google services.
Specifies whether the GCM channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
Specifies whether the GCM channel is archived.
The user who last modified the GCM channel.
The date and time when the GCM channel was last modified.
The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.
The current version of the GCM channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_import_job(**kwargs)¶Retrieves information about the status and settings of a specific import job for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_import_job(
ApplicationId='string',
JobId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the job.
dict
Response Syntax
{
'ImportJobResponse': {
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'DefineSegment': True|False,
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RegisterEndpoints': True|False,
'RoleArn': 'string',
'S3Url': 'string',
'SegmentId': 'string',
'SegmentName': 'string'
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'PREPARING_FOR_INITIALIZATION'|'INITIALIZING'|'PROCESSING'|'PENDING_JOB'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ImportJobResponse (dict) --
Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the import job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the import job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the import job was created.
Definition (dict) --
The resource settings that apply to the import job.
DefineSegment (boolean) --
Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
RegisterEndpoints (boolean) --
Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
SegmentId (string) --
The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
SegmentName (string) --
The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
Id (string) --
The unique identifier for the import job.
JobStatus (string) --
The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the import job.
Type (string) --
The job type. This value is IMPORT for import jobs.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_import_jobs(**kwargs)¶Retrieves information about the status and settings of all the import jobs for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_import_jobs(
ApplicationId='string',
PageSize='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'ImportJobsResponse': {
'Item': [
{
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'DefineSegment': True|False,
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RegisterEndpoints': True|False,
'RoleArn': 'string',
'S3Url': 'string',
'SegmentId': 'string',
'SegmentName': 'string'
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'PREPARING_FOR_INITIALIZATION'|'INITIALIZING'|'PROCESSING'|'PENDING_JOB'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ImportJobsResponse (dict) --
Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.
Item (list) --
An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).
(dict) --
Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the import job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the import job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the import job was created.
Definition (dict) --
The resource settings that apply to the import job.
DefineSegment (boolean) --
Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
RegisterEndpoints (boolean) --
Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
SegmentId (string) --
The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
SegmentName (string) --
The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
Id (string) --
The unique identifier for the import job.
JobStatus (string) --
The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the import job.
Type (string) --
The job type. This value is IMPORT for import jobs.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_in_app_messages(**kwargs)¶Retrieves the in-app messages targeted for the provided endpoint ID.
See also: AWS API Documentation
Request Syntax
response = client.get_in_app_messages(
ApplicationId='string',
EndpointId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the endpoint.
dict
Response Syntax
{
'InAppMessagesResponse': {
'InAppMessageCampaigns': [
{
'CampaignId': 'string',
'DailyCap': 123,
'InAppMessage': {
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
},
'Priority': 123,
'Schedule': {
'EndDate': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'QuietTime': {
'End': 'string',
'Start': 'string'
}
},
'SessionCap': 123,
'TotalCap': 123,
'TreatmentId': 'string'
},
]
}
}
Response Structure
(dict) --
The request succeeded.
InAppMessagesResponse (dict) --
Get in-app messages response object.
InAppMessageCampaigns (list) --
List of targeted in-app message campaigns.
(dict) --
Targeted in-app message campaign.
CampaignId (string) --
Campaign id of the corresponding campaign.
DailyCap (integer) --
Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
InAppMessage (dict) --
In-app message content with all fields required for rendering an in-app message.
Content (list) --
In-app message content.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CustomConfig (dict) --
Custom config to be sent to SDK.
Layout (string) --
The layout of the message.
Priority (integer) --
Priority of the in-app message.
Schedule (dict) --
Schedule of the campaign.
EndDate (string) --
The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.
EventFilter (dict) --
The event filter the SDK has to use to show the in-app message in the application.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
QuietTime (dict) --
Time during which the in-app message should not be shown to the user.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
SessionCap (integer) --
Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
TotalCap (integer) --
Total cap which controls the number of times an in-app message can be shown to the endpoint.
TreatmentId (string) --
Treatment id of the campaign.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_in_app_template(**kwargs)¶Retrieves the content and settings of a message template for messages sent through the in-app channel.
See also: AWS API Documentation
Request Syntax
response = client.get_in_app_template(
TemplateName='string',
Version='string'
)
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
dict
Response Syntax
{
'InAppTemplateResponse': {
'Arn': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CreationDate': 'string',
'CustomConfig': {
'string': 'string'
},
'LastModifiedDate': 'string',
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string',
'TemplateName': 'string',
'TemplateType': 'EMAIL'|'SMS'|'VOICE'|'PUSH'|'INAPP',
'Version': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
InAppTemplateResponse (dict) --
In-App Template Response.
Arn (string) --
The resource arn of the template.
Content (list) --
The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CreationDate (string) --
The creation date of the template.
CustomConfig (dict) --
Custom config to be sent to client.
LastModifiedDate (string) --
The last modified date of the template.
Layout (string) --
The layout of the message.
tags (dict) --
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
TemplateDescription (string) --
The description of the template.
TemplateName (string) --
The name of the template.
TemplateType (string) --
The type of the template.
Version (string) --
The version id of the template.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_journey(**kwargs)¶Retrieves information about the status, configuration, and other settings for a journey.
See also: AWS API Documentation
Request Syntax
response = client.get_journey(
ApplicationId='string',
JourneyId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the journey.
dict
Response Syntax
{
'JourneyResponse': {
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'ContactCenter': {
'NextActivity': 'string'
}
}
},
'ApplicationId': 'string',
'CreationDate': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123,
'EndpointReentryInterval': 'string'
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED'|'PAUSED',
'tags': {
'string': 'string'
},
'WaitForQuietTime': True|False,
'RefreshOnSegmentUpdate': True|False,
'JourneyChannelSettings': {
'ConnectCampaignArn': 'string',
'ConnectCampaignExecutionRoleArn': 'string'
},
'SendingSchedule': True|False,
'OpenHours': {
'EMAIL': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'SMS': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'PUSH': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'VOICE': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'CUSTOM': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
}
},
'ClosedDays': {
'EMAIL': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'SMS': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'PUSH': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'VOICE': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'CUSTOM': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
]
}
}
}
Response Structure
(dict) --
The request succeeded.
JourneyResponse (dict) --
Provides information about the status, configuration, and other settings for a journey.
Activities (dict) --
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
(string) --
(dict) --
Specifies the configuration and other settings for an activity in a journey.
CUSTOM (dict) --
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
MessageConfig (dict) --
Specifies the message data included in a custom channel message that's sent to participants in a journey.
Data (string) --
The message content that's passed to an AWS Lambda function or to a web hook.
NextActivity (string) --
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
TemplateName (string) --
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
ConditionalSplit (dict) --
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
Condition (dict) --
The conditions that define the paths for the activity, and the relationship between the conditions.
Conditions (list) --
The conditions to evaluate for the activity.
(dict) --
Specifies a condition to evaluate for an activity in a journey.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Operator (string) --
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
EvaluationWaitTime (dict) --
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
FalseActivity (string) --
The unique identifier for the activity to perform if the conditions aren't met.
TrueActivity (string) --
The unique identifier for the activity to perform if the conditions are met.
Description (string) --
The custom description of the activity.
EMAIL (dict) --
The settings for an email activity. This type of activity sends an email message to participants.
MessageConfig (dict) --
Specifies the sender address for an email message that's sent to participants in the journey.
FromAddress (string) --
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Holdout (dict) --
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the holdout activity.
Percentage (integer) --
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
MultiCondition (dict) --
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
(dict) --
Specifies a condition to evaluate for an activity path in a journey.
Condition (dict) --
The condition to evaluate for the activity path.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
DefaultActivity (string) --
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
EvaluationWaitTime (dict) --
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
PUSH (dict) --
The settings for a push notification activity. This type of activity sends a push notification to participants.
MessageConfig (dict) --
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
TimeToLive (string) --
The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
RandomSplit (dict) --
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
(dict) --
Specifies the settings for a path in a random split activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
Percentage (integer) --
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
SMS (dict) --
The settings for an SMS activity. This type of activity sends a text message to participants.
MessageConfig (dict) --
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Wait (dict) --
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the wait activity.
WaitTime (dict) --
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
ContactCenter (dict) --
The settings for a connect activity. This type of activity initiates a contact center call to participants.
NextActivity (string) --
The unique identifier for the next activity to perform after the this activity.
ApplicationId (string) --
The unique identifier for the application that the journey applies to.
CreationDate (string) --
The date, in ISO 8601 format, when the journey was created.
Id (string) --
The unique identifier for the journey.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the journey was last modified.
Limits (dict) --
The messaging and entry limits for the journey.
DailyCap (integer) --
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
EndpointReentryCap (integer) --
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
MessagesPerSecond (integer) --
The maximum number of messages that the journey can send each second.
EndpointReentryInterval (string) --
Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.
LocalTime (boolean) --
Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
Name (string) --
The name of the journey.
QuietTime (dict) --
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
RefreshFrequency (string) --
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Schedule (dict) --
The schedule settings for the journey.
EndTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey ended or will end.
StartTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey began or will begin.
Timezone (string) --
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
StartActivity (string) --
The unique identifier for the first activity in the journey.
StartCondition (dict) --
The segment that defines which users are participants in the journey.
Description (string) --
The custom description of the condition.
EventStartCondition (dict) --
Specifies the settings for an event that causes a journey activity to start.
EventFilter (dict) --
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Dimensions (dict) --
The dimensions for the event filter to use for the campaign or the journey activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
SegmentId (string) --
SegmentStartCondition (dict) --
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
State (string) --
The current status of the journey. Possible values are:
tags (dict) --
This object is not used or supported.
WaitForQuietTime (boolean) --
Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
RefreshOnSegmentUpdate (boolean) --
Specifies whether a journey should be refreshed on segment update.
JourneyChannelSettings (dict) --
The channel-specific configurations for the journey.
ConnectCampaignArn (string) --
Amazon Resource Name (ARN) of the Connect Campaign.
ConnectCampaignExecutionRoleArn (string) --
IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
SendingSchedule (boolean) --
Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)
OpenHours (dict) --
The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
EMAIL (dict) --
Rules for Email Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
SMS (dict) --
Rules for SMS Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
PUSH (dict) --
Rules for Push Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
VOICE (dict) --
Rules for Voice Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
CUSTOM (dict) --
Rules for Custom Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
ClosedDays (dict) --
The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.
EMAIL (list) --
Rules for Email Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
SMS (list) --
Rules for SMS Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
PUSH (list) --
Rules for Push Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
VOICE (list) --
Rules for Voice Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
CUSTOM (list) --
Rules for Custom Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_journey_date_range_kpi(**kwargs)¶Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
See also: AWS API Documentation
Request Syntax
response = client.get_journey_date_range_kpi(
ApplicationId='string',
EndTime=datetime(2015, 1, 1),
JourneyId='string',
KpiName='string',
NextToken='string',
PageSize='string',
StartTime=datetime(2015, 1, 1)
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the journey.
[REQUIRED]
The name of the metric, also referred to as a key performance indicator (KPI) , to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide .
dict
Response Syntax
{
'JourneyDateRangeKpiResponse': {
'ApplicationId': 'string',
'EndTime': datetime(2015, 1, 1),
'JourneyId': 'string',
'KpiName': 'string',
'KpiResult': {
'Rows': [
{
'GroupedBys': [
{
'Key': 'string',
'Type': 'string',
'Value': 'string'
},
],
'Values': [
{
'Key': 'string',
'Type': 'string',
'Value': 'string'
},
]
},
]
},
'NextToken': 'string',
'StartTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
The request succeeded.
JourneyDateRangeKpiResponse (dict) --
Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.
ApplicationId (string) --
The unique identifier for the application that the metric applies to.
EndTime (datetime) --
The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
JourneyId (string) --
The unique identifier for the journey that the metric applies to.
KpiName (string) --
The name of the metric, also referred to as a key performance indicator (KPI) , that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide .
KpiResult (dict) --
An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
Rows (list) --
An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
(dict) --
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
GroupedBys (list) --
An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.
(dict) --
Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.
Key (string) --
The friendly name of the metric whose value is specified by the Value property.
Type (string) --
The data type of the value specified by the Value property.
Value (string) --
In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).
Values (list) --
An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.
(dict) --
Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.
Key (string) --
The friendly name of the metric whose value is specified by the Value property.
Type (string) --
The data type of the value specified by the Value property.
Value (string) --
In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.
StartTime (datetime) --
The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_journey_execution_activity_metrics(**kwargs)¶Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
See also: AWS API Documentation
Request Syntax
response = client.get_journey_execution_activity_metrics(
ApplicationId='string',
JourneyActivityId='string',
JourneyId='string',
NextToken='string',
PageSize='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the journey activity.
[REQUIRED]
The unique identifier for the journey.
dict
Response Syntax
{
'JourneyExecutionActivityMetricsResponse': {
'ActivityType': 'string',
'ApplicationId': 'string',
'JourneyActivityId': 'string',
'JourneyId': 'string',
'LastEvaluatedTime': 'string',
'Metrics': {
'string': 'string'
}
}
}
Response Structure
(dict) --
The request succeeded.
JourneyExecutionActivityMetricsResponse (dict) --
Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.
ActivityType (string) --
The type of activity that the metric applies to. Possible values are:
ApplicationId (string) --
The unique identifier for the application that the metric applies to.
JourneyActivityId (string) --
The unique identifier for the activity that the metric applies to.
JourneyId (string) --
The unique identifier for the journey that the metric applies to.
LastEvaluatedTime (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.
Metrics (dict) --
A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide .
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_journey_execution_metrics(**kwargs)¶Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
See also: AWS API Documentation
Request Syntax
response = client.get_journey_execution_metrics(
ApplicationId='string',
JourneyId='string',
NextToken='string',
PageSize='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the journey.
dict
Response Syntax
{
'JourneyExecutionMetricsResponse': {
'ApplicationId': 'string',
'JourneyId': 'string',
'LastEvaluatedTime': 'string',
'Metrics': {
'string': 'string'
}
}
}
Response Structure
(dict) --
The request succeeded.
JourneyExecutionMetricsResponse (dict) --
Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.
ApplicationId (string) --
The unique identifier for the application that the metric applies to.
JourneyId (string) --
The unique identifier for the journey that the metric applies to.
LastEvaluatedTime (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.
Metrics (dict) --
A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide .
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_push_template(**kwargs)¶Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
See also: AWS API Documentation
Request Syntax
response = client.get_push_template(
TemplateName='string',
Version='string'
)
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
dict
Response Syntax
{
'PushNotificationTemplateResponse': {
'ADM': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'APNS': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'Arn': 'string',
'Baidu': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'CreationDate': 'string',
'Default': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'DefaultSubstitutions': 'string',
'GCM': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'LastModifiedDate': 'string',
'RecommenderId': 'string',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string',
'TemplateName': 'string',
'TemplateType': 'EMAIL'|'SMS'|'VOICE'|'PUSH'|'INAPP',
'Version': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
PushNotificationTemplateResponse (dict) --
Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.
ADM (dict) --
The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
Body (string) --
The message body to use in a push notification that's based on the message template.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
ImageUrl (string) --
The URL of an image to display in a push notification that's based on the message template.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Title (string) --
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
APNS (dict) --
The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
Body (string) --
The message body to use in push notifications that are based on the message template.
MediaUrl (string) --
The URL of an image or video to display in push notifications that are based on the message template.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.
Sound (string) --
The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
Title (string) --
The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
Arn (string) --
The Amazon Resource Name (ARN) of the message template.
Baidu (dict) --
The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
Body (string) --
The message body to use in a push notification that's based on the message template.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
ImageUrl (string) --
The URL of an image to display in a push notification that's based on the message template.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Title (string) --
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
CreationDate (string) --
The date, in ISO 8601 format, when the message template was created.
Default (dict) --
The default message template that's used for push notification channels.
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
Body (string) --
The message body to use in push notifications that are based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
Title (string) --
The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
DefaultSubstitutions (string) --
The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
GCM (dict) --
The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
Action (string) --
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
Body (string) --
The message body to use in a push notification that's based on the message template.
ImageIconUrl (string) --
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
ImageUrl (string) --
The URL of an image to display in a push notification that's based on the message template.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
SmallImageIconUrl (string) --
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sound (string) --
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Title (string) --
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the message template was last modified.
RecommenderId (string) --
The unique identifier for the recommender model that's used by the message template.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
TemplateDescription (string) --
The custom description of the message template.
TemplateName (string) --
The name of the message template.
TemplateType (string) --
The type of channel that the message template is designed for. For a push notification template, this value is PUSH.
Version (string) --
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_recommender_configuration(**kwargs)¶Retrieves information about an Amazon Pinpoint configuration for a recommender model.
See also: AWS API Documentation
Request Syntax
response = client.get_recommender_configuration(
RecommenderId='string'
)
[REQUIRED]
The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
{
'RecommenderConfigurationResponse': {
'Attributes': {
'string': 'string'
},
'CreationDate': 'string',
'Description': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Name': 'string',
'RecommendationProviderIdType': 'string',
'RecommendationProviderRoleArn': 'string',
'RecommendationProviderUri': 'string',
'RecommendationTransformerUri': 'string',
'RecommendationsDisplayName': 'string',
'RecommendationsPerMessage': 123
}
}
Response Structure
The request succeeded.
Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
The custom description of the configuration for the recommender model.
The unique identifier for the recommender model configuration.
The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
The custom name of the configuration for the recommender model.
The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.
The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_recommender_configurations(**kwargs)¶Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
See also: AWS API Documentation
Request Syntax
response = client.get_recommender_configurations(
PageSize='string',
Token='string'
)
dict
Response Syntax
{
'ListRecommenderConfigurationsResponse': {
'Item': [
{
'Attributes': {
'string': 'string'
},
'CreationDate': 'string',
'Description': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Name': 'string',
'RecommendationProviderIdType': 'string',
'RecommendationProviderRoleArn': 'string',
'RecommendationProviderUri': 'string',
'RecommendationTransformerUri': 'string',
'RecommendationsDisplayName': 'string',
'RecommendationsPerMessage': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ListRecommenderConfigurationsResponse (dict) --
Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
Item (list) --
An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.
(dict) --
Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
Attributes (dict) --
A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
CreationDate (string) --
The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
Description (string) --
The custom description of the configuration for the recommender model.
Id (string) --
The unique identifier for the recommender model configuration.
LastModifiedDate (string) --
The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
Name (string) --
The custom name of the configuration for the recommender model.
RecommendationProviderIdType (string) --
The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:
RecommendationProviderRoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
RecommendationProviderUri (string) --
The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.
RecommendationTransformerUri (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.
RecommendationsDisplayName (string) --
The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
RecommendationsPerMessage (integer) --
The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_segment(**kwargs)¶Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.get_segment(
ApplicationId='string',
SegmentId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the segment.
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'tags': {
'string': 'string'
},
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
SegmentResponse (dict) --
Provides information about the configuration, dimension, and other settings for a segment.
ApplicationId (string) --
The unique identifier for the application that the segment is associated with.
Arn (string) --
The Amazon Resource Name (ARN) of the segment.
CreationDate (string) --
The date and time when the segment was created.
Dimensions (dict) --
The dimension settings for the segment.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Id (string) --
The unique identifier for the segment.
ImportDefinition (dict) --
The settings for the import job that's associated with the segment.
ChannelCounts (dict) --
The number of channel types in the endpoint definitions that were imported to create the segment.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Size (integer) --
The number of endpoint definitions that were imported successfully to create the segment.
LastModifiedDate (string) --
The date and time when the segment was last modified.
Name (string) --
The name of the segment.
SegmentGroups (dict) --
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
Groups (list) --
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
(dict) --
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Dimensions (list) --
An array that defines the dimensions for the segment.
(dict) --
Specifies the dimension settings for a segment.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
SourceSegments (list) --
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
(dict) --
Specifies the segment identifier and version of a segment.
Id (string) --
The unique identifier for the segment.
Version (integer) --
The version number of the segment.
SourceType (string) --
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Type (string) --
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Include (string) --
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
SegmentType (string) --
The segment type. Valid values are:
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
Version (integer) --
The version number of the segment.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_segment_export_jobs(**kwargs)¶Retrieves information about the status and settings of the export jobs for a segment.
See also: AWS API Documentation
Request Syntax
response = client.get_segment_export_jobs(
ApplicationId='string',
PageSize='string',
SegmentId='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the segment.
dict
Response Syntax
{
'ExportJobsResponse': {
'Item': [
{
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'RoleArn': 'string',
'S3UrlPrefix': 'string',
'SegmentId': 'string',
'SegmentVersion': 123
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'PREPARING_FOR_INITIALIZATION'|'INITIALIZING'|'PROCESSING'|'PENDING_JOB'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ExportJobsResponse (dict) --
Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.
Item (list) --
An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).
(dict) --
Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the export job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the export job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the export job was created.
Definition (dict) --
The resource settings that apply to the export job.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.
S3UrlPrefix (string) --
The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
SegmentId (string) --
The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.
SegmentVersion (integer) --
The version of the segment that the endpoint definitions were exported from.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
Id (string) --
The unique identifier for the export job.
JobStatus (string) --
The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the export job.
Type (string) --
The job type. This value is EXPORT for export jobs.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_segment_import_jobs(**kwargs)¶Retrieves information about the status and settings of the import jobs for a segment.
See also: AWS API Documentation
Request Syntax
response = client.get_segment_import_jobs(
ApplicationId='string',
PageSize='string',
SegmentId='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the segment.
dict
Response Syntax
{
'ImportJobsResponse': {
'Item': [
{
'ApplicationId': 'string',
'CompletedPieces': 123,
'CompletionDate': 'string',
'CreationDate': 'string',
'Definition': {
'DefineSegment': True|False,
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RegisterEndpoints': True|False,
'RoleArn': 'string',
'S3Url': 'string',
'SegmentId': 'string',
'SegmentName': 'string'
},
'FailedPieces': 123,
'Failures': [
'string',
],
'Id': 'string',
'JobStatus': 'CREATED'|'PREPARING_FOR_INITIALIZATION'|'INITIALIZING'|'PROCESSING'|'PENDING_JOB'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
'TotalFailures': 123,
'TotalPieces': 123,
'TotalProcessed': 123,
'Type': 'string'
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
ImportJobsResponse (dict) --
Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.
Item (list) --
An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).
(dict) --
Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
ApplicationId (string) --
The unique identifier for the application that's associated with the import job.
CompletedPieces (integer) --
The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
CompletionDate (string) --
The date, in ISO 8601 format, when the import job was completed.
CreationDate (string) --
The date, in ISO 8601 format, when the import job was created.
Definition (dict) --
The resource settings that apply to the import job.
DefineSegment (boolean) --
Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
RegisterEndpoints (boolean) --
Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
SegmentId (string) --
The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
SegmentName (string) --
The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
FailedPieces (integer) --
The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
Failures (list) --
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
Id (string) --
The unique identifier for the import job.
JobStatus (string) --
The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
TotalFailures (integer) --
The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.
TotalPieces (integer) --
The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.
TotalProcessed (integer) --
The total number of endpoint definitions that were processed by the import job.
Type (string) --
The job type. This value is IMPORT for import jobs.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_segment_version(**kwargs)¶Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.get_segment_version(
ApplicationId='string',
SegmentId='string',
Version='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the segment.
[REQUIRED]
The unique version number (Version property) for the campaign version.
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'tags': {
'string': 'string'
},
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
SegmentResponse (dict) --
Provides information about the configuration, dimension, and other settings for a segment.
ApplicationId (string) --
The unique identifier for the application that the segment is associated with.
Arn (string) --
The Amazon Resource Name (ARN) of the segment.
CreationDate (string) --
The date and time when the segment was created.
Dimensions (dict) --
The dimension settings for the segment.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Id (string) --
The unique identifier for the segment.
ImportDefinition (dict) --
The settings for the import job that's associated with the segment.
ChannelCounts (dict) --
The number of channel types in the endpoint definitions that were imported to create the segment.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Size (integer) --
The number of endpoint definitions that were imported successfully to create the segment.
LastModifiedDate (string) --
The date and time when the segment was last modified.
Name (string) --
The name of the segment.
SegmentGroups (dict) --
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
Groups (list) --
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
(dict) --
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Dimensions (list) --
An array that defines the dimensions for the segment.
(dict) --
Specifies the dimension settings for a segment.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
SourceSegments (list) --
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
(dict) --
Specifies the segment identifier and version of a segment.
Id (string) --
The unique identifier for the segment.
Version (integer) --
The version number of the segment.
SourceType (string) --
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Type (string) --
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Include (string) --
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
SegmentType (string) --
The segment type. Valid values are:
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
Version (integer) --
The version number of the segment.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_segment_versions(**kwargs)¶Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.get_segment_versions(
ApplicationId='string',
PageSize='string',
SegmentId='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the segment.
dict
Response Syntax
{
'SegmentsResponse': {
'Item': [
{
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'tags': {
'string': 'string'
},
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
SegmentsResponse (dict) --
Provides information about all the segments that are associated with an application.
Item (list) --
An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).
(dict) --
Provides information about the configuration, dimension, and other settings for a segment.
ApplicationId (string) --
The unique identifier for the application that the segment is associated with.
Arn (string) --
The Amazon Resource Name (ARN) of the segment.
CreationDate (string) --
The date and time when the segment was created.
Dimensions (dict) --
The dimension settings for the segment.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Id (string) --
The unique identifier for the segment.
ImportDefinition (dict) --
The settings for the import job that's associated with the segment.
ChannelCounts (dict) --
The number of channel types in the endpoint definitions that were imported to create the segment.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Size (integer) --
The number of endpoint definitions that were imported successfully to create the segment.
LastModifiedDate (string) --
The date and time when the segment was last modified.
Name (string) --
The name of the segment.
SegmentGroups (dict) --
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
Groups (list) --
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
(dict) --
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Dimensions (list) --
An array that defines the dimensions for the segment.
(dict) --
Specifies the dimension settings for a segment.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
SourceSegments (list) --
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
(dict) --
Specifies the segment identifier and version of a segment.
Id (string) --
The unique identifier for the segment.
Version (integer) --
The version number of the segment.
SourceType (string) --
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Type (string) --
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Include (string) --
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
SegmentType (string) --
The segment type. Valid values are:
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
Version (integer) --
The version number of the segment.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_segments(**kwargs)¶Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.get_segments(
ApplicationId='string',
PageSize='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'SegmentsResponse': {
'Item': [
{
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'tags': {
'string': 'string'
},
'Version': 123
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
SegmentsResponse (dict) --
Provides information about all the segments that are associated with an application.
Item (list) --
An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).
(dict) --
Provides information about the configuration, dimension, and other settings for a segment.
ApplicationId (string) --
The unique identifier for the application that the segment is associated with.
Arn (string) --
The Amazon Resource Name (ARN) of the segment.
CreationDate (string) --
The date and time when the segment was created.
Dimensions (dict) --
The dimension settings for the segment.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Id (string) --
The unique identifier for the segment.
ImportDefinition (dict) --
The settings for the import job that's associated with the segment.
ChannelCounts (dict) --
The number of channel types in the endpoint definitions that were imported to create the segment.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Size (integer) --
The number of endpoint definitions that were imported successfully to create the segment.
LastModifiedDate (string) --
The date and time when the segment was last modified.
Name (string) --
The name of the segment.
SegmentGroups (dict) --
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
Groups (list) --
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
(dict) --
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Dimensions (list) --
An array that defines the dimensions for the segment.
(dict) --
Specifies the dimension settings for a segment.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
SourceSegments (list) --
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
(dict) --
Specifies the segment identifier and version of a segment.
Id (string) --
The unique identifier for the segment.
Version (integer) --
The version number of the segment.
SourceType (string) --
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Type (string) --
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Include (string) --
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
SegmentType (string) --
The segment type. Valid values are:
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
Version (integer) --
The version number of the segment.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_sms_channel(**kwargs)¶Retrieves information about the status and settings of the SMS channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_sms_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'SMSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'PromotionalMessagesPerSecond': 123,
'SenderId': 'string',
'ShortCode': 'string',
'TransactionalMessagesPerSecond': 123,
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the SMS channel for an application.
The unique identifier for the application that the SMS channel applies to.
The date and time, in ISO 8601 format, when the SMS channel was enabled.
Specifies whether the SMS channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
Specifies whether the SMS channel is archived.
The user who last modified the SMS channel.
The date and time, in ISO 8601 format, when the SMS channel was last modified.
The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
The maximum number of promotional messages that you can send through the SMS channel each second.
The identity that displays on recipients' devices when they receive messages from the SMS channel.
The registered short code to use when you send messages through the SMS channel.
The maximum number of transactional messages that you can send through the SMS channel each second.
The current version of the SMS channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_sms_template(**kwargs)¶Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
See also: AWS API Documentation
Request Syntax
response = client.get_sms_template(
TemplateName='string',
Version='string'
)
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
dict
Response Syntax
{
'SMSTemplateResponse': {
'Arn': 'string',
'Body': 'string',
'CreationDate': 'string',
'DefaultSubstitutions': 'string',
'LastModifiedDate': 'string',
'RecommenderId': 'string',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string',
'TemplateName': 'string',
'TemplateType': 'EMAIL'|'SMS'|'VOICE'|'PUSH'|'INAPP',
'Version': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
SMSTemplateResponse (dict) --
Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
Arn (string) --
The Amazon Resource Name (ARN) of the message template.
Body (string) --
The message body that's used in text messages that are based on the message template.
CreationDate (string) --
The date, in ISO 8601 format, when the message template was created.
DefaultSubstitutions (string) --
The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the message template was last modified.
RecommenderId (string) --
The unique identifier for the recommender model that's used by the message template.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
TemplateDescription (string) --
The custom description of the message template.
TemplateName (string) --
The name of the message template.
TemplateType (string) --
The type of channel that the message template is designed for. For an SMS template, this value is SMS.
Version (string) --
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_user_endpoints(**kwargs)¶Retrieves information about all the endpoints that are associated with a specific user ID.
See also: AWS API Documentation
Request Syntax
response = client.get_user_endpoints(
ApplicationId='string',
UserId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the user.
dict
Response Syntax
{
'EndpointsResponse': {
'Item': [
{
'Address': 'string',
'ApplicationId': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
'CohortId': 'string',
'CreationDate': 'string',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Id': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
},
]
}
}
Response Structure
(dict) --
The request succeeded.
EndpointsResponse (dict) --
Provides information about all the endpoints that are associated with a user ID.
Item (list) --
An array of responses, one for each endpoint that's associated with the user ID.
(dict) --
Provides information about the channel type and other settings for an endpoint.
Address (string) --
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
ApplicationId (string) --
The unique identifier for the application that's associated with the endpoint.
Attributes (dict) --
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments.
ChannelType (string) --
The channel that's used when sending messages or push notifications to the endpoint.
CohortId (string) --
A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
CreationDate (string) --
The date and time, in ISO 8601 format, when the endpoint was created.
Demographic (dict) --
The demographic information for the endpoint, such as the time zone and platform.
AppVersion (string) --
The version of the app that's associated with the endpoint.
Locale (string) --
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
Make (string) --
The manufacturer of the endpoint device, such as apple or samsung.
Model (string) --
The model name or number of the endpoint device, such as iPhone or SM-G900F.
ModelVersion (string) --
The model version of the endpoint device.
Platform (string) --
The platform of the endpoint device, such as ios.
PlatformVersion (string) --
The platform version of the endpoint device.
Timezone (string) --
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
EffectiveDate (string) --
The date and time, in ISO 8601 format, when the endpoint was last updated.
EndpointStatus (string) --
Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
Id (string) --
The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
Location (dict) --
The geographic information for the endpoint.
City (string) --
The name of the city where the endpoint is located.
Country (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
Latitude (float) --
The latitude coordinate of the endpoint location, rounded to one decimal place.
Longitude (float) --
The longitude coordinate of the endpoint location, rounded to one decimal place.
PostalCode (string) --
The postal or ZIP code for the area where the endpoint is located.
Region (string) --
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
Metrics (dict) --
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
OptOut (string) --
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
RequestId (string) --
The unique identifier for the most recent request to update the endpoint.
User (dict) --
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
UserAttributes (dict) --
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
UserId (string) --
The unique identifier for the user.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_voice_channel(**kwargs)¶Retrieves information about the status and settings of the voice channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.get_voice_channel(
ApplicationId='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
{
'VoiceChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
The request succeeded.
Provides information about the status and settings of the voice channel for an application.
The unique identifier for the application that the voice channel applies to.
The date and time, in ISO 8601 format, when the voice channel was enabled.
Specifies whether the voice channel is enabled for the application.
(Not used) This property is retained only for backward compatibility.
(Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
Specifies whether the voice channel is archived.
The user who last modified the voice channel.
The date and time, in ISO 8601 format, when the voice channel was last modified.
The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.
The current version of the voice channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_voice_template(**kwargs)¶Retrieves the content and settings of a message template for messages that are sent through the voice channel.
See also: AWS API Documentation
Request Syntax
response = client.get_voice_template(
TemplateName='string',
Version='string'
)
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
dict
Response Syntax
{
'VoiceTemplateResponse': {
'Arn': 'string',
'Body': 'string',
'CreationDate': 'string',
'DefaultSubstitutions': 'string',
'LanguageCode': 'string',
'LastModifiedDate': 'string',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string',
'TemplateName': 'string',
'TemplateType': 'EMAIL'|'SMS'|'VOICE'|'PUSH'|'INAPP',
'Version': 'string',
'VoiceId': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
VoiceTemplateResponse (dict) --
Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.
Arn (string) --
The Amazon Resource Name (ARN) of the message template.
Body (string) --
The text of the script that's used in messages that are based on the message template, in plain text format.
CreationDate (string) --
The date, in ISO 8601 format, when the message template was created.
DefaultSubstitutions (string) --
The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
LanguageCode (string) --
The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide .
LastModifiedDate (string) --
The date, in ISO 8601 format, when the message template was last modified.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
TemplateDescription (string) --
The custom description of the message template.
TemplateName (string) --
The name of the message template.
TemplateType (string) --
The type of channel that the message template is designed for. For a voice template, this value is VOICE.
Version (string) --
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
VoiceId (string) --
The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide .
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_journeys(**kwargs)¶Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.list_journeys(
ApplicationId='string',
PageSize='string',
Token='string'
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'JourneysResponse': {
'Item': [
{
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'ContactCenter': {
'NextActivity': 'string'
}
}
},
'ApplicationId': 'string',
'CreationDate': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123,
'EndpointReentryInterval': 'string'
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED'|'PAUSED',
'tags': {
'string': 'string'
},
'WaitForQuietTime': True|False,
'RefreshOnSegmentUpdate': True|False,
'JourneyChannelSettings': {
'ConnectCampaignArn': 'string',
'ConnectCampaignExecutionRoleArn': 'string'
},
'SendingSchedule': True|False,
'OpenHours': {
'EMAIL': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'SMS': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'PUSH': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'VOICE': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'CUSTOM': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
}
},
'ClosedDays': {
'EMAIL': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'SMS': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'PUSH': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'VOICE': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'CUSTOM': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
]
}
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
JourneysResponse (dict) --
Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.
Item (list) --
An array of responses, one for each journey that's associated with the application.
(dict) --
Provides information about the status, configuration, and other settings for a journey.
Activities (dict) --
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
(string) --
(dict) --
Specifies the configuration and other settings for an activity in a journey.
CUSTOM (dict) --
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
MessageConfig (dict) --
Specifies the message data included in a custom channel message that's sent to participants in a journey.
Data (string) --
The message content that's passed to an AWS Lambda function or to a web hook.
NextActivity (string) --
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
TemplateName (string) --
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
ConditionalSplit (dict) --
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
Condition (dict) --
The conditions that define the paths for the activity, and the relationship between the conditions.
Conditions (list) --
The conditions to evaluate for the activity.
(dict) --
Specifies a condition to evaluate for an activity in a journey.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Operator (string) --
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
EvaluationWaitTime (dict) --
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
FalseActivity (string) --
The unique identifier for the activity to perform if the conditions aren't met.
TrueActivity (string) --
The unique identifier for the activity to perform if the conditions are met.
Description (string) --
The custom description of the activity.
EMAIL (dict) --
The settings for an email activity. This type of activity sends an email message to participants.
MessageConfig (dict) --
Specifies the sender address for an email message that's sent to participants in the journey.
FromAddress (string) --
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Holdout (dict) --
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the holdout activity.
Percentage (integer) --
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
MultiCondition (dict) --
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
(dict) --
Specifies a condition to evaluate for an activity path in a journey.
Condition (dict) --
The condition to evaluate for the activity path.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
DefaultActivity (string) --
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
EvaluationWaitTime (dict) --
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
PUSH (dict) --
The settings for a push notification activity. This type of activity sends a push notification to participants.
MessageConfig (dict) --
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
TimeToLive (string) --
The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
RandomSplit (dict) --
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
(dict) --
Specifies the settings for a path in a random split activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
Percentage (integer) --
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
SMS (dict) --
The settings for an SMS activity. This type of activity sends a text message to participants.
MessageConfig (dict) --
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Wait (dict) --
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the wait activity.
WaitTime (dict) --
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
ContactCenter (dict) --
The settings for a connect activity. This type of activity initiates a contact center call to participants.
NextActivity (string) --
The unique identifier for the next activity to perform after the this activity.
ApplicationId (string) --
The unique identifier for the application that the journey applies to.
CreationDate (string) --
The date, in ISO 8601 format, when the journey was created.
Id (string) --
The unique identifier for the journey.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the journey was last modified.
Limits (dict) --
The messaging and entry limits for the journey.
DailyCap (integer) --
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
EndpointReentryCap (integer) --
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
MessagesPerSecond (integer) --
The maximum number of messages that the journey can send each second.
EndpointReentryInterval (string) --
Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.
LocalTime (boolean) --
Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
Name (string) --
The name of the journey.
QuietTime (dict) --
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
RefreshFrequency (string) --
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Schedule (dict) --
The schedule settings for the journey.
EndTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey ended or will end.
StartTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey began or will begin.
Timezone (string) --
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
StartActivity (string) --
The unique identifier for the first activity in the journey.
StartCondition (dict) --
The segment that defines which users are participants in the journey.
Description (string) --
The custom description of the condition.
EventStartCondition (dict) --
Specifies the settings for an event that causes a journey activity to start.
EventFilter (dict) --
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Dimensions (dict) --
The dimensions for the event filter to use for the campaign or the journey activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
SegmentId (string) --
SegmentStartCondition (dict) --
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
State (string) --
The current status of the journey. Possible values are:
tags (dict) --
This object is not used or supported.
WaitForQuietTime (boolean) --
Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
RefreshOnSegmentUpdate (boolean) --
Specifies whether a journey should be refreshed on segment update.
JourneyChannelSettings (dict) --
The channel-specific configurations for the journey.
ConnectCampaignArn (string) --
Amazon Resource Name (ARN) of the Connect Campaign.
ConnectCampaignExecutionRoleArn (string) --
IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
SendingSchedule (boolean) --
Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)
OpenHours (dict) --
The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
EMAIL (dict) --
Rules for Email Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
SMS (dict) --
Rules for SMS Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
PUSH (dict) --
Rules for Push Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
VOICE (dict) --
Rules for Voice Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
CUSTOM (dict) --
Rules for Custom Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
ClosedDays (dict) --
The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.
EMAIL (list) --
Rules for Email Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
SMS (list) --
Rules for SMS Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
PUSH (list) --
Rules for Push Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
VOICE (list) --
Rules for Voice Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
CUSTOM (list) --
Rules for Custom Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionRetrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
{
'TagsModel': {
'tags': {
'string': 'string'
}
}
}
Response Structure
The request succeeded.
Specifies the tags (keys and values) for an application, campaign, message template, or segment.
A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.
Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
list_template_versions(**kwargs)¶Retrieves information about all the versions of a specific message template.
See also: AWS API Documentation
Request Syntax
response = client.list_template_versions(
NextToken='string',
PageSize='string',
TemplateName='string',
TemplateType='string'
)
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
[REQUIRED]
The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.
dict
Response Syntax
{
'TemplateVersionsResponse': {
'Item': [
{
'CreationDate': 'string',
'DefaultSubstitutions': 'string',
'LastModifiedDate': 'string',
'TemplateDescription': 'string',
'TemplateName': 'string',
'TemplateType': 'string',
'Version': 'string'
},
],
'Message': 'string',
'NextToken': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
TemplateVersionsResponse (dict) --
Provides information about all the versions of a specific message template.
Item (list) --
An array of responses, one for each version of the message template.
(dict) --
Provides information about a specific version of a message template.
CreationDate (string) --
The date, in ISO 8601 format, when the version of the message template was created.
DefaultSubstitutions (string) --
A JSON object that specifies the default values that are used for message variables in the version of the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the version of the message template was last modified.
TemplateDescription (string) --
The custom description of the version of the message template.
TemplateName (string) --
The name of the message template.
TemplateType (string) --
The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.
Version (string) --
The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.
Message (string) --
The message that's returned from the API for the request to retrieve information about all the versions of the message template.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
RequestID (string) --
The unique identifier for the request to retrieve information about all the versions of the message template.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionlist_templates(**kwargs)¶Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
See also: AWS API Documentation
Request Syntax
response = client.list_templates(
NextToken='string',
PageSize='string',
Prefix='string',
TemplateType='string'
)
dict
Response Syntax
{
'TemplatesResponse': {
'Item': [
{
'Arn': 'string',
'CreationDate': 'string',
'DefaultSubstitutions': 'string',
'LastModifiedDate': 'string',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string',
'TemplateName': 'string',
'TemplateType': 'EMAIL'|'SMS'|'VOICE'|'PUSH'|'INAPP',
'Version': 'string'
},
],
'NextToken': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
TemplatesResponse (dict) --
Provides information about all the message templates that are associated with your Amazon Pinpoint account.
Item (list) --
An array of responses, one for each message template that's associated with your Amazon Pinpoint account and meets any filter criteria that you specified in the request.
(dict) --
Provides information about a message template that's associated with your Amazon Pinpoint account.
Arn (string) --
The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.
CreationDate (string) --
The date, in ISO 8601 format, when the message template was created.
DefaultSubstitutions (string) --
The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the message template was last modified.
tags (dict) --
A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
TemplateDescription (string) --
The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.
TemplateName (string) --
The name of the message template.
TemplateType (string) --
The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.
Version (string) --
The unique identifier, as an integer, for the active version of the message template.
NextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Exceptions
Pinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionPinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.ForbiddenExceptionphone_number_validate(**kwargs)¶Retrieves information about a phone number.
See also: AWS API Documentation
Request Syntax
response = client.phone_number_validate(
NumberValidateRequest={
'IsoCountryCode': 'string',
'PhoneNumber': 'string'
}
)
[REQUIRED]
Specifies a phone number to validate and retrieve information about.
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.
{
'NumberValidateResponse': {
'Carrier': 'string',
'City': 'string',
'CleansedPhoneNumberE164': 'string',
'CleansedPhoneNumberNational': 'string',
'Country': 'string',
'CountryCodeIso2': 'string',
'CountryCodeNumeric': 'string',
'County': 'string',
'OriginalCountryCodeIso2': 'string',
'OriginalPhoneNumber': 'string',
'PhoneType': 'string',
'PhoneTypeCode': 123,
'Timezone': 'string',
'ZipCode': 'string'
}
}
Response Structure
The request succeeded.
Provides information about a phone number.
The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.
The name of the city where the phone number was originally registered.
The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.
The cleansed phone number, in the format for the location where the phone number was originally registered.
The name of the country or region where the phone number was originally registered.
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
The numeric code for the country or region where the phone number was originally registered.
The name of the county where the phone number was originally registered.
The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.
The phone number that was sent in the request body.
The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.
The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).
The time zone for the location where the phone number was originally registered.
The postal or ZIP code for the location where the phone number was originally registered.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionput_event_stream(**kwargs)¶Creates a new event stream for an application or updates the settings of an existing event stream for an application.
See also: AWS API Documentation
Request Syntax
response = client.put_event_stream(
ApplicationId='string',
WriteEventStream={
'DestinationStreamArn': 'string',
'RoleArn': 'string'
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.
The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
dict
Response Syntax
{
'EventStream': {
'ApplicationId': 'string',
'DestinationStreamArn': 'string',
'ExternalId': 'string',
'LastModifiedDate': 'string',
'LastUpdatedBy': 'string',
'RoleArn': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
EventStream (dict) --
Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.
ApplicationId (string) --
The unique identifier for the application to publish event data for.
DestinationStreamArn (string) --
The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the event stream was last modified.
LastUpdatedBy (string) --
The IAM user who last modified the event stream.
RoleArn (string) --
The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionput_events(**kwargs)¶Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
See also: AWS API Documentation
Request Syntax
response = client.put_events(
ApplicationId='string',
EventsRequest={
'BatchItem': {
'string': {
'Endpoint': {
'Address': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
},
'Events': {
'string': {
'AppPackageName': 'string',
'AppTitle': 'string',
'AppVersionCode': 'string',
'Attributes': {
'string': 'string'
},
'ClientSdkVersion': 'string',
'EventType': 'string',
'Metrics': {
'string': 123.0
},
'SdkName': 'string',
'Session': {
'Duration': 123,
'Id': 'string',
'StartTimestamp': 'string',
'StopTimestamp': 'string'
},
'Timestamp': 'string'
}
}
}
}
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies a batch of events to process.
The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value.
Specifies a batch of endpoints and events to process.
A set of properties and attributes that are associated with the endpoint.
The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.
The channel that's used when sending messages or push notifications to the endpoint.
The demographic information for the endpoint, such as the time zone and platform.
The version of the app that's associated with the endpoint.
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
The manufacturer of the endpoint device, such as apple or samsung.
The model name or number of the endpoint device, such as iPhone or SM-G900F.
The model version of the endpoint device.
The platform of the endpoint device, such as ios.
The platform version of the endpoint device.
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
The date and time, in ISO 8601 format, when the endpoint was last updated.
Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
The geographic information for the endpoint.
The name of the city where the endpoint is located.
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
The latitude coordinate of the endpoint location, rounded to one decimal place.
The longitude coordinate of the endpoint location, rounded to one decimal place.
The postal or ZIP code for the area where the endpoint is located.
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
A unique identifier that's generated each time the endpoint is updated.
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
The unique identifier for the user.
A set of properties that are associated with the event.
Specifies information about an event that reports data to Amazon Pinpoint.
The package name of the app that's recording the event.
The title of the app that's recording the event.
The version number of the app that's recording the event.
One or more custom attributes that are associated with the event.
The version of the SDK that's running on the client device.
The name of the event.
One or more custom metrics that are associated with the event.
The name of the SDK that's being used to record the event.
Information about the session in which the event occurred.
The duration of the session, in milliseconds.
The unique identifier for the session.
The date and time when the session began.
The date and time when the session ended.
The date and time, in ISO 8601 format, when the event occurred.
dict
Response Syntax
{
'EventsResponse': {
'Results': {
'string': {
'EndpointItemResponse': {
'Message': 'string',
'StatusCode': 123
},
'EventsItemResponse': {
'string': {
'Message': 'string',
'StatusCode': 123
}
}
}
}
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
EventsResponse (dict) --
Provides information about endpoints and the events that they're associated with.
Results (dict) --
A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.
(string) --
(dict) --
Provides information about the results of a request to create or update an endpoint that's associated with an event.
EndpointItemResponse (dict) --
The response that was received after the endpoint data was accepted.
Message (string) --
The custom message that's returned in the response as a result of processing the endpoint data.
StatusCode (integer) --
The status code that's returned in the response as a result of processing the endpoint data.
EventsItemResponse (dict) --
A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.
(string) --
(dict) --
Provides the status code and message that result from processing an event.
Message (string) --
A custom message that's returned in the response as a result of processing the event.
StatusCode (integer) --
The status code that's returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren't valid.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionremove_attributes(**kwargs)¶Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.remove_attributes(
ApplicationId='string',
AttributeType='string',
UpdateAttributesRequest={
'Blacklist': [
'string',
]
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The type of attribute or attributes to remove. Valid values are:
[REQUIRED]
Specifies one or more attributes to remove from all the endpoints that are associated with an application.
An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.
dict
Response Syntax
{
'AttributesResource': {
'ApplicationId': 'string',
'AttributeType': 'string',
'Attributes': [
'string',
]
}
}
Response Structure
(dict) --
The request succeeded.
AttributesResource (dict) --
Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.
ApplicationId (string) --
The unique identifier for the application.
AttributeType (string) --
The type of attribute or attributes that were removed from the endpoints. Valid values are:
Attributes (list) --
An array that specifies the names of the attributes that were removed from the endpoints.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionsend_messages(**kwargs)¶Creates and sends a direct message.
See also: AWS API Documentation
Request Syntax
response = client.send_messages(
ApplicationId='string',
MessageRequest={
'Addresses': {
'string': {
'BodyOverride': 'string',
'ChannelType': 'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
'Context': {
'string': 'string'
},
'RawContent': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TitleOverride': 'string'
}
},
'Context': {
'string': 'string'
},
'Endpoints': {
'string': {
'BodyOverride': 'string',
'Context': {
'string': 'string'
},
'RawContent': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TitleOverride': 'string'
}
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ConsolidationKey': 'string',
'Data': {
'string': 'string'
},
'ExpiresAfter': 'string',
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'MD5': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'APNSPushType': 'string',
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Badge': 123,
'Body': 'string',
'Category': 'string',
'CollapseId': 'string',
'Data': {
'string': 'string'
},
'MediaUrl': 'string',
'PreferredAuthenticationMethod': 'string',
'Priority': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'ThreadId': 'string',
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Data': {
'string': 'string'
},
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Body': 'string',
'Substitutions': {
'string': [
'string',
]
}
},
'DefaultPushNotificationMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Data': {
'string': 'string'
},
'SilentPush': True|False,
'Substitutions': {
'string': [
'string',
]
},
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FeedbackForwardingAddress': 'string',
'FromAddress': 'string',
'RawEmail': {
'Data': b'bytes'
},
'ReplyToAddresses': [
'string',
],
'SimpleEmail': {
'HtmlPart': {
'Charset': 'string',
'Data': 'string'
},
'Subject': {
'Charset': 'string',
'Data': 'string'
},
'TextPart': {
'Charset': 'string',
'Data': 'string'
}
},
'Substitutions': {
'string': [
'string',
]
}
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'CollapseKey': 'string',
'Data': {
'string': 'string'
},
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'Priority': 'string',
'RawContent': 'string',
'RestrictedPackageName': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'Keyword': 'string',
'MediaUrl': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'Substitutions': {
'string': [
'string',
]
},
'EntityId': 'string',
'TemplateId': 'string'
},
'VoiceMessage': {
'Body': 'string',
'LanguageCode': 'string',
'OriginationNumber': 'string',
'Substitutions': {
'string': [
'string',
]
},
'VoiceId': 'string'
}
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TraceId': 'string'
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the configuration and other settings for a message.
A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
Specifies address-based configuration settings for a message that's sent directly to an endpoint.
The message body to use instead of the default message body. This value overrides the default message body.
The channel to use when sending the message.
An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.
For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.
The message title to use instead of the default message title. This value overrides the default message title.
A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.
The body of the message. If specified, this value overrides the default message body.
A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.
For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.
The title or subject line of the message. If specified, this value overrides the default message title or subject line.
The settings and content for the default message and any default messages that you defined for specific channels.
The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
The action to occur if the recipient taps the push notification. Valid values are:
The body of the notification message.
An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.
The icon image name of the asset saved in your app.
The URL of the large icon image to display in the content view of the push notification.
The URL of an image to display in the push notification.
The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
The URL of the small icon image to display in the status bar and the content view of the push notification.
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
The title to display above the notification message on the recipient's device.
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
The type of push notification to send. Valid values are:
Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.
For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.
The action to occur if the recipient taps the push notification. Valid values are:
The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.
The body of the notification message.
The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.
An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.
Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.
The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
The URL of an image or video to display in the push notification.
The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.
para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.
/listitem> * 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device. /para>
Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.
The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Note
If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.
Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.
Note
If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.
The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
The default message variables to use in the notification message. You can override these default variables with individual address variables.
The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.
The title to display above the notification message on the recipient's device.
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
The action to occur if the recipient taps the push notification. Valid values are:
The body of the notification message.
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
The icon image name of the asset saved in your app.
The URL of the large icon image to display in the content view of the push notification.
The URL of an image to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
The URL of the small icon image to display in the status bar and the content view of the push notification.
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).
The title to display above the notification message on the recipient's device.
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The default message for all channels.
The default body of the message.
The default message variables to use in the message. You can override these default variables with individual address variables.
The default push notification message for all push notification channels.
The default action to occur if a recipient taps the push notification. Valid values are:
The default body of the notification message.
The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
The default title to display above the notification message on a recipient's device.
The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The default message for the email channel. This message overrides the default message (DefaultMessage).
The body of the email message.
The email address to forward bounces and complaints to, if feedback forwarding is enabled.
The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.
The email message, represented as a raw MIME message.
The email message, represented as a raw MIME message. The entire message must be base64 encoded.
The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.
The email message, composed of a subject, a text part, and an HTML part.
The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
The applicable character set for the message content.
The textual data of the message content.
The subject line, or title, of the email.
The applicable character set for the message content.
The textual data of the message content.
The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
The applicable character set for the message content.
The textual data of the message content.
The default message variables to use in the email message. You can override the default variables with individual address variables.
The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).
The action to occur if the recipient taps the push notification. Valid values are:
The body of the notification message.
An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.
Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
The icon image name of the asset saved in your app.
The URL of the large icon image to display in the content view of the push notification.
The URL of an image to display in the push notification.
para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.
/listitem> * high - The notification is sent immediately and might wake a sleeping device. /para>
Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.
The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
The package name of the application where registration tokens must match in order for the recipient to receive the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
The URL of the small icon image to display in the status bar and the content view of the push notification.
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).
Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.
The title to display above the notification message on the recipient's device.
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The default message for the SMS channel. This message overrides the default message (DefaultMessage).
The body of the SMS message.
The SMS program name that you provided to AWS Support when you requested your dedicated number.
This field is reserved for future use.
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
The message variables to use in the SMS message. You can override the default variables with individual address variables.
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
The template ID received from the regulatory body for sending SMS in your country.
The default message for the voice channel. This message overrides the default message (DefaultMessage).
The text of the script to use for the voice message.
The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide .
The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.
The default message variables to use in the voice message. You can override the default variables with individual address variables.
The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide .
The message template to use for the message.
The email template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The push notification template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The SMS template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The voice template to use for the message. This object isn't supported for campaigns.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The unique identifier for tracing the message. This identifier is visible to message recipients.
dict
Response Syntax
{
'MessageResponse': {
'ApplicationId': 'string',
'EndpointResult': {
'string': {
'Address': 'string',
'DeliveryStatus': 'SUCCESSFUL'|'THROTTLED'|'TEMPORARY_FAILURE'|'PERMANENT_FAILURE'|'UNKNOWN_FAILURE'|'OPT_OUT'|'DUPLICATE',
'MessageId': 'string',
'StatusCode': 123,
'StatusMessage': 'string',
'UpdatedToken': 'string'
}
},
'RequestId': 'string',
'Result': {
'string': {
'DeliveryStatus': 'SUCCESSFUL'|'THROTTLED'|'TEMPORARY_FAILURE'|'PERMANENT_FAILURE'|'UNKNOWN_FAILURE'|'OPT_OUT'|'DUPLICATE',
'MessageId': 'string',
'StatusCode': 123,
'StatusMessage': 'string',
'UpdatedToken': 'string'
}
}
}
}
Response Structure
(dict) --
The request succeeded.
MessageResponse (dict) --
Provides information about the results of a request to send a message to an endpoint address.
ApplicationId (string) --
The unique identifier for the application that was used to send the message.
EndpointResult (dict) --
A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.
(string) --
(dict) --
Provides information about the delivery status and results of sending a message directly to an endpoint.
Address (string) --
The endpoint address that the message was delivered to.
DeliveryStatus (string) --
The delivery status of the message. Possible values are:
MessageId (string) --
The unique identifier for the message that was sent.
StatusCode (integer) --
The downstream service status code for delivering the message.
StatusMessage (string) --
The status message for delivering the message.
UpdatedToken (string) --
For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
RequestId (string) --
The identifier for the original request that the message was delivered for.
Result (dict) --
A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.
(string) --
(dict) --
Provides information about the results of sending a message directly to an endpoint address.
DeliveryStatus (string) --
The delivery status of the message. Possible values are:
MessageId (string) --
The unique identifier for the message that was sent.
StatusCode (integer) --
The downstream service status code for delivering the message.
StatusMessage (string) --
The status message for delivering the message.
UpdatedToken (string) --
For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionsend_otp_message(**kwargs)¶Send an OTP message
See also: AWS API Documentation
Request Syntax
response = client.send_otp_message(
ApplicationId='string',
SendOTPMessageRequestParameters={
'AllowedAttempts': 123,
'BrandName': 'string',
'Channel': 'string',
'CodeLength': 123,
'DestinationIdentity': 'string',
'EntityId': 'string',
'Language': 'string',
'OriginationIdentity': 'string',
'ReferenceId': 'string',
'TemplateId': 'string',
'ValidityPeriod': 123
}
)
[REQUIRED]
The unique ID of your Amazon Pinpoint application.
[REQUIRED]
Send OTP message request parameters.
The attempts allowed to validate an OTP.
The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.
Channel type for the OTP message. Supported values: [SMS].
The number of characters in the generated OTP.
The destination identity to send OTP to.
A unique Entity ID received from DLT after entity registration is approved.
The language to be used for the outgoing message body containing the OTP.
The origination identity used to send OTP from.
Developer-specified reference identifier. Required to match during OTP verification.
A unique Template ID received from DLT after entity registration is approved.
The time in minutes before the OTP is no longer valid.
dict
Response Syntax
{
'MessageResponse': {
'ApplicationId': 'string',
'EndpointResult': {
'string': {
'Address': 'string',
'DeliveryStatus': 'SUCCESSFUL'|'THROTTLED'|'TEMPORARY_FAILURE'|'PERMANENT_FAILURE'|'UNKNOWN_FAILURE'|'OPT_OUT'|'DUPLICATE',
'MessageId': 'string',
'StatusCode': 123,
'StatusMessage': 'string',
'UpdatedToken': 'string'
}
},
'RequestId': 'string',
'Result': {
'string': {
'DeliveryStatus': 'SUCCESSFUL'|'THROTTLED'|'TEMPORARY_FAILURE'|'PERMANENT_FAILURE'|'UNKNOWN_FAILURE'|'OPT_OUT'|'DUPLICATE',
'MessageId': 'string',
'StatusCode': 123,
'StatusMessage': 'string',
'UpdatedToken': 'string'
}
}
}
}
Response Structure
(dict) --
200 response
MessageResponse (dict) --
Provides information about the results of a request to send a message to an endpoint address.
ApplicationId (string) --
The unique identifier for the application that was used to send the message.
EndpointResult (dict) --
A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.
(string) --
(dict) --
Provides information about the delivery status and results of sending a message directly to an endpoint.
Address (string) --
The endpoint address that the message was delivered to.
DeliveryStatus (string) --
The delivery status of the message. Possible values are:
MessageId (string) --
The unique identifier for the message that was sent.
StatusCode (integer) --
The downstream service status code for delivering the message.
StatusMessage (string) --
The status message for delivering the message.
UpdatedToken (string) --
For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
RequestId (string) --
The identifier for the original request that the message was delivered for.
Result (dict) --
A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.
(string) --
(dict) --
Provides information about the results of sending a message directly to an endpoint address.
DeliveryStatus (string) --
The delivery status of the message. Possible values are:
MessageId (string) --
The unique identifier for the message that was sent.
StatusCode (integer) --
The downstream service status code for delivering the message.
StatusMessage (string) --
The status message for delivering the message.
UpdatedToken (string) --
For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionsend_users_messages(**kwargs)¶Creates and sends a message to a list of users.
See also: AWS API Documentation
Request Syntax
response = client.send_users_messages(
ApplicationId='string',
SendUsersMessageRequest={
'Context': {
'string': 'string'
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ConsolidationKey': 'string',
'Data': {
'string': 'string'
},
'ExpiresAfter': 'string',
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'MD5': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'APNSPushType': 'string',
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Badge': 123,
'Body': 'string',
'Category': 'string',
'CollapseId': 'string',
'Data': {
'string': 'string'
},
'MediaUrl': 'string',
'PreferredAuthenticationMethod': 'string',
'Priority': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'ThreadId': 'string',
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Data': {
'string': 'string'
},
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'DefaultMessage': {
'Body': 'string',
'Substitutions': {
'string': [
'string',
]
}
},
'DefaultPushNotificationMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Data': {
'string': 'string'
},
'SilentPush': True|False,
'Substitutions': {
'string': [
'string',
]
},
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FeedbackForwardingAddress': 'string',
'FromAddress': 'string',
'RawEmail': {
'Data': b'bytes'
},
'ReplyToAddresses': [
'string',
],
'SimpleEmail': {
'HtmlPart': {
'Charset': 'string',
'Data': 'string'
},
'Subject': {
'Charset': 'string',
'Data': 'string'
},
'TextPart': {
'Charset': 'string',
'Data': 'string'
}
},
'Substitutions': {
'string': [
'string',
]
}
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'CollapseKey': 'string',
'Data': {
'string': 'string'
},
'IconReference': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'Priority': 'string',
'RawContent': 'string',
'RestrictedPackageName': 'string',
'SilentPush': True|False,
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'Keyword': 'string',
'MediaUrl': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'Substitutions': {
'string': [
'string',
]
},
'EntityId': 'string',
'TemplateId': 'string'
},
'VoiceMessage': {
'Body': 'string',
'LanguageCode': 'string',
'OriginationNumber': 'string',
'Substitutions': {
'string': [
'string',
]
},
'VoiceId': 'string'
}
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TraceId': 'string',
'Users': {
'string': {
'BodyOverride': 'string',
'Context': {
'string': 'string'
},
'RawContent': 'string',
'Substitutions': {
'string': [
'string',
]
},
'TitleOverride': 'string'
}
}
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.
A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.
The settings and content for the default message and any default messages that you defined for specific channels.
The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
The action to occur if the recipient taps the push notification. Valid values are:
The body of the notification message.
An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.
The icon image name of the asset saved in your app.
The URL of the large icon image to display in the content view of the push notification.
The URL of an image to display in the push notification.
The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
The URL of the small icon image to display in the status bar and the content view of the push notification.
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
The title to display above the notification message on the recipient's device.
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
The type of push notification to send. Valid values are:
Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.
For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.
The action to occur if the recipient taps the push notification. Valid values are:
The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.
The body of the notification message.
The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.
An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.
Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.
The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
The URL of an image or video to display in the push notification.
The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.
para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.
/listitem> * 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device. /para>
Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.
The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Note
If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.
Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.
Note
If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.
The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
The default message variables to use in the notification message. You can override these default variables with individual address variables.
The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.
The title to display above the notification message on the recipient's device.
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
The action to occur if the recipient taps the push notification. Valid values are:
The body of the notification message.
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
The icon image name of the asset saved in your app.
The URL of the large icon image to display in the content view of the push notification.
The URL of an image to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
The URL of the small icon image to display in the status bar and the content view of the push notification.
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).
The title to display above the notification message on the recipient's device.
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The default message for all channels.
The default body of the message.
The default message variables to use in the message. You can override these default variables with individual address variables.
The default push notification message for all push notification channels.
The default action to occur if a recipient taps the push notification. Valid values are:
The default body of the notification message.
The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
The default title to display above the notification message on a recipient's device.
The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The default message for the email channel. This message overrides the default message (DefaultMessage).
The body of the email message.
The email address to forward bounces and complaints to, if feedback forwarding is enabled.
The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.
The email message, represented as a raw MIME message.
The email message, represented as a raw MIME message. The entire message must be base64 encoded.
The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.
The email message, composed of a subject, a text part, and an HTML part.
The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
The applicable character set for the message content.
The textual data of the message content.
The subject line, or title, of the email.
The applicable character set for the message content.
The textual data of the message content.
The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
The applicable character set for the message content.
The textual data of the message content.
The default message variables to use in the email message. You can override the default variables with individual address variables.
The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).
The action to occur if the recipient taps the push notification. Valid values are:
The body of the notification message.
An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.
Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
The icon image name of the asset saved in your app.
The URL of the large icon image to display in the content view of the push notification.
The URL of an image to display in the push notification.
para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.
/listitem> * high - The notification is sent immediately and might wake a sleeping device. /para>
Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.
The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
The package name of the application where registration tokens must match in order for the recipient to receive the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
The URL of the small icon image to display in the status bar and the content view of the push notification.
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).
Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.
The title to display above the notification message on the recipient's device.
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The default message for the SMS channel. This message overrides the default message (DefaultMessage).
The body of the SMS message.
The SMS program name that you provided to AWS Support when you requested your dedicated number.
This field is reserved for future use.
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
The message variables to use in the SMS message. You can override the default variables with individual address variables.
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
The template ID received from the regulatory body for sending SMS in your country.
The default message for the voice channel. This message overrides the default message (DefaultMessage).
The text of the script to use for the voice message.
The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide .
The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.
The default message variables to use in the voice message. You can override the default variables with individual address variables.
The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide .
The message template to use for the message.
The email template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The push notification template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The SMS template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The voice template to use for the message. This object isn't supported for campaigns.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The unique identifier for tracing the message. This identifier is visible to message recipients.
A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.
Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.
The body of the message. If specified, this value overrides the default message body.
A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.
For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.
The title or subject line of the message. If specified, this value overrides the default message title or subject line.
dict
Response Syntax
{
'SendUsersMessageResponse': {
'ApplicationId': 'string',
'RequestId': 'string',
'Result': {
'string': {
'string': {
'Address': 'string',
'DeliveryStatus': 'SUCCESSFUL'|'THROTTLED'|'TEMPORARY_FAILURE'|'PERMANENT_FAILURE'|'UNKNOWN_FAILURE'|'OPT_OUT'|'DUPLICATE',
'MessageId': 'string',
'StatusCode': 123,
'StatusMessage': 'string',
'UpdatedToken': 'string'
}
}
}
}
}
Response Structure
(dict) --
The request succeeded.
SendUsersMessageResponse (dict) --
Provides information about which users and endpoints a message was sent to.
ApplicationId (string) --
The unique identifier for the application that was used to send the message.
RequestId (string) --
The unique identifier that was assigned to the message request.
Result (dict) --
An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.
(string) --
(dict) --
(string) --
(dict) --
Provides information about the delivery status and results of sending a message directly to an endpoint.
Address (string) --
The endpoint address that the message was delivered to.
DeliveryStatus (string) --
The delivery status of the message. Possible values are:
MessageId (string) --
The unique identifier for the message that was sent.
StatusCode (integer) --
The downstream service status code for delivering the message.
StatusMessage (string) --
The status message for delivering the message.
UpdatedToken (string) --
For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptiontag_resource(**kwargs)¶Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
TagsModel={
'tags': {
'string': 'string'
}
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
Specifies the tags (keys and values) for an application, campaign, message template, or segment.
A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.
Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
None
untag_resource(**kwargs)¶Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).
None
update_adm_channel(**kwargs)¶Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_adm_channel(
ADMChannelRequest={
'ClientId': 'string',
'ClientSecret': 'string',
'Enabled': True|False
},
ApplicationId='string'
)
[REQUIRED]
Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.
The Client ID that you received from Amazon to send messages by using ADM.
The Client Secret that you received from Amazon to send messages by using ADM.
Specifies whether to enable the ADM channel for the application.
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'ADMChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
ADMChannelResponse (dict) --
Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
ApplicationId (string) --
The unique identifier for the application that the ADM channel applies to.
CreationDate (string) --
The date and time when the ADM channel was enabled.
Enabled (boolean) --
Specifies whether the ADM channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
Id (string) --
(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the ADM channel is archived.
LastModifiedBy (string) --
The user who last modified the ADM channel.
LastModifiedDate (string) --
The date and time when the ADM channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.
Version (integer) --
The current version of the ADM channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_apns_channel(**kwargs)¶Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_apns_channel(
APNSChannelRequest={
'BundleId': 'string',
'Certificate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'PrivateKey': 'string',
'TeamId': 'string',
'TokenKey': 'string',
'TokenKeyId': 'string'
},
ApplicationId='string'
)
[REQUIRED]
Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
Specifies whether to enable the APNs channel for the application.
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
The authentication key to use for APNs tokens.
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'APNSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
APNSChannelResponse (dict) --
Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
ApplicationId (string) --
The unique identifier for the application that the APNs channel applies to.
CreationDate (string) --
The date and time when the APNs channel was enabled.
DefaultAuthenticationMethod (string) --
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
Enabled (boolean) --
Specifies whether the APNs channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
HasTokenKey (boolean) --
Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
Id (string) --
(Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the APNs channel is archived.
LastModifiedBy (string) --
The user who last modified the APNs channel.
LastModifiedDate (string) --
The date and time when the APNs channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.
Version (integer) --
The current version of the APNs channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_apns_sandbox_channel(**kwargs)¶Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_apns_sandbox_channel(
APNSSandboxChannelRequest={
'BundleId': 'string',
'Certificate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'PrivateKey': 'string',
'TeamId': 'string',
'TokenKey': 'string',
'TokenKeyId': 'string'
},
ApplicationId='string'
)
[REQUIRED]
Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.
Specifies whether to enable the APNs sandbox channel for the application.
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
The authentication key to use for APNs tokens.
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'APNSSandboxChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
APNSSandboxChannelResponse (dict) --
Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
ApplicationId (string) --
The unique identifier for the application that the APNs sandbox channel applies to.
CreationDate (string) --
The date and time when the APNs sandbox channel was enabled.
DefaultAuthenticationMethod (string) --
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
Enabled (boolean) --
Specifies whether the APNs sandbox channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
HasTokenKey (boolean) --
Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
Id (string) --
(Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the APNs sandbox channel is archived.
LastModifiedBy (string) --
The user who last modified the APNs sandbox channel.
LastModifiedDate (string) --
The date and time when the APNs sandbox channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.
Version (integer) --
The current version of the APNs sandbox channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_apns_voip_channel(**kwargs)¶Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_apns_voip_channel(
APNSVoipChannelRequest={
'BundleId': 'string',
'Certificate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'PrivateKey': 'string',
'TeamId': 'string',
'TokenKey': 'string',
'TokenKeyId': 'string'
},
ApplicationId='string'
)
[REQUIRED]
Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
Specifies whether to enable the APNs VoIP channel for the application.
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
The authentication key to use for APNs tokens.
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'APNSVoipChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
APNSVoipChannelResponse (dict) --
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
ApplicationId (string) --
The unique identifier for the application that the APNs VoIP channel applies to.
CreationDate (string) --
The date and time when the APNs VoIP channel was enabled.
DefaultAuthenticationMethod (string) --
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
Enabled (boolean) --
Specifies whether the APNs VoIP channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
HasTokenKey (boolean) --
Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
Id (string) --
(Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the APNs VoIP channel is archived.
LastModifiedBy (string) --
The user who last modified the APNs VoIP channel.
LastModifiedDate (string) --
The date and time when the APNs VoIP channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.
Version (integer) --
The current version of the APNs VoIP channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_apns_voip_sandbox_channel(**kwargs)¶Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_apns_voip_sandbox_channel(
APNSVoipSandboxChannelRequest={
'BundleId': 'string',
'Certificate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'PrivateKey': 'string',
'TeamId': 'string',
'TokenKey': 'string',
'TokenKeyId': 'string'
},
ApplicationId='string'
)
[REQUIRED]
Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.
Specifies whether the APNs VoIP sandbox channel is enabled for the application.
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
The authentication key to use for APNs tokens.
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
dict
Response Syntax
{
'APNSVoipSandboxChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'DefaultAuthenticationMethod': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'HasTokenKey': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
APNSVoipSandboxChannelResponse (dict) --
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
ApplicationId (string) --
The unique identifier for the application that the APNs VoIP sandbox channel applies to.
CreationDate (string) --
The date and time when the APNs VoIP sandbox channel was enabled.
DefaultAuthenticationMethod (string) --
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
Enabled (boolean) --
Specifies whether the APNs VoIP sandbox channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
HasTokenKey (boolean) --
Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
Id (string) --
(Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the APNs VoIP sandbox channel is archived.
LastModifiedBy (string) --
The user who last modified the APNs VoIP sandbox channel.
LastModifiedDate (string) --
The date and time when the APNs VoIP sandbox channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
Version (integer) --
The current version of the APNs VoIP sandbox channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_application_settings(**kwargs)¶Updates the settings for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_application_settings(
ApplicationId='string',
WriteApplicationSettingsRequest={
'CampaignHook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'CloudWatchMetricsEnabled': True|False,
'EventTaggingEnabled': True|False,
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123,
'Session': 123
},
'QuietTime': {
'End': 'string',
'Start': 'string'
}
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the default settings for an application.
The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaignresource.
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Specifies whether to enable application-related alarms in Amazon CloudWatch.
The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaignresource or the Journeyresource, respectively.
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
The maximum total number of messages that the campaign can send per user session.
The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
To override the default quiet time settings for a specific campaign or journey, use the Campaignresource or the Journeyresource to define a custom quiet time for the campaign or journey.
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
dict
Response Syntax
{
'ApplicationSettingsResource': {
'ApplicationId': 'string',
'CampaignHook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123,
'Session': 123
},
'QuietTime': {
'End': 'string',
'Start': 'string'
}
}
}
Response Structure
(dict) --
The request succeeded.
ApplicationSettingsResource (dict) --
Provides information about an application, including the default settings for an application.
ApplicationId (string) --
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
CampaignHook (dict) --
The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
LastModifiedDate (string) --
The date and time, in ISO 8601 format, when the application's settings were last modified.
Limits (dict) --
The default sending limits for campaigns in the application.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
Session (integer) --
The maximum total number of messages that the campaign can send per user session.
QuietTime (dict) --
The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_baidu_channel(**kwargs)¶Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_baidu_channel(
ApplicationId='string',
BaiduChannelRequest={
'ApiKey': 'string',
'Enabled': True|False,
'SecretKey': 'string'
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
The API key that you received from the Baidu Cloud Push service to communicate with the service.
Specifies whether to enable the Baidu channel for the application.
The secret key that you received from the Baidu Cloud Push service to communicate with the service.
dict
Response Syntax
{
'BaiduChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Credential': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
BaiduChannelResponse (dict) --
Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
ApplicationId (string) --
The unique identifier for the application that the Baidu channel applies to.
CreationDate (string) --
The date and time when the Baidu channel was enabled.
Credential (string) --
The API key that you received from the Baidu Cloud Push service to communicate with the service.
Enabled (boolean) --
Specifies whether the Baidu channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
Id (string) --
(Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the Baidu channel is archived.
LastModifiedBy (string) --
The user who last modified the Baidu channel.
LastModifiedDate (string) --
The date and time when the Baidu channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
Version (integer) --
The current version of the Baidu channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_campaign(**kwargs)¶Updates the configuration and other settings for a campaign.
See also: AWS API Documentation
Request Syntax
response = client.update_campaign(
ApplicationId='string',
CampaignId='string',
WriteCampaignRequest={
'AdditionalTreatments': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'IsPaused': True|False,
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123,
'Session': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Priority': 123
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the campaign.
[REQUIRED]
Specifies the configuration and other settings for a campaign.
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
The destination to send the campaign or treatment to. This value can be one of the following:
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
The message configuration settings for the treatment.
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
The default message that the campaign sends through all the channels that are configured for the campaign.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
The body of the email for recipients whose email clients don't render HTML content.
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
The body of the email, in HTML format, for recipients whose email clients render HTML content.
The subject line, or title, of the email.
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
The body of the SMS message.
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
The sender ID to display on recipients' devices when they receive the SMS message.
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
The template ID received from the regulatory body for sending SMS in your country.
The in-app message configuration.
The message body of the notification, the email body or the text message.
In-app message content.
The configuration for the message content.
The background color for the message.
The configuration for the message body.
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Message Body.
The text color.
The configuration for the message header.
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Message Header.
The text color.
The image url for the background of message.
The first button inside the message.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
The background color of the button.
The border radius of the button.
Action triggered by the button.
Button destination.
Button text.
The text color of the button.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
Action triggered by the button.
Button destination.
The second button inside message.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
The background color of the button.
The border radius of the button.
Action triggered by the button.
Button destination.
Button text.
The text color of the button.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
Action triggered by the button.
Button destination.
Custom config to be sent to client.
In-app message layout.
The schedule settings for the treatment.
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
The dimension settings of the event filter for the campaign.
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
The allocated percentage of users (segment members) to send the treatment to.
The message template to use for the treatment.
The email template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The push notification template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The SMS template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The voice template to use for the message. This object isn't supported for campaigns.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
A custom description of the treatment.
A custom name for the treatment.
The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.
The destination to send the campaign or treatment to. This value can be one of the following:
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
A custom description of the campaign.
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
The messaging limits for the campaign.
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
The maximum total number of messages that the campaign can send per user session.
The message configuration settings for the campaign.
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
The default message that the campaign sends through all the channels that are configured for the campaign.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
The body of the email for recipients whose email clients don't render HTML content.
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
The body of the email, in HTML format, for recipients whose email clients render HTML content.
The subject line, or title, of the email.
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
The action to occur if a recipient taps the push notification. Valid values are:
The body of the notification message. The maximum number of characters is 200.
The URL of the image to display as the push-notification icon, such as the icon for the app.
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
The URL of an image to display in the push notification.
The JSON payload to use for a silent push notification.
The URL of the image or video to display in the push notification.
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The title to display above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
The body of the SMS message.
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
The sender ID to display on recipients' devices when they receive the SMS message.
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
The template ID received from the regulatory body for sending SMS in your country.
The in-app message configuration.
The message body of the notification, the email body or the text message.
In-app message content.
The configuration for the message content.
The background color for the message.
The configuration for the message body.
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Message Body.
The text color.
The configuration for the message header.
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Message Header.
The text color.
The image url for the background of message.
The first button inside the message.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
The background color of the button.
The border radius of the button.
Action triggered by the button.
Button destination.
Button text.
The text color of the button.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
Action triggered by the button.
Button destination.
The second button inside message.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
The background color of the button.
The border radius of the button.
Action triggered by the button.
Button destination.
Button text.
The text color of the button.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
Action triggered by the button.
Button destination.
Custom config to be sent to client.
In-app message layout.
A custom name for the campaign.
The schedule settings for the campaign.
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
The dimension settings of the event filter for the campaign.
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
The unique identifier for the segment to associate with the campaign.
The version of the segment to associate with the campaign.
A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.
The message template to use for the campaign.
The email template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The push notification template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The SMS template to use for the message.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The voice template to use for the message. This object isn't supported for campaigns.
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
A custom description of the default treatment for the campaign.
A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
dict
Response Syntax
{
'CampaignResponse': {
'AdditionalTreatments': [
{
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'Id': 'string',
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SizePercent': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string'
},
],
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'CustomDeliveryConfiguration': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
]
},
'DefaultState': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'Description': 'string',
'HoldoutPercent': 123,
'Hook': {
'LambdaFunctionName': 'string',
'Mode': 'DELIVERY'|'FILTER',
'WebUrl': 'string'
},
'Id': 'string',
'IsPaused': True|False,
'LastModifiedDate': 'string',
'Limits': {
'Daily': 123,
'MaximumDuration': 123,
'MessagesPerSecond': 123,
'Total': 123,
'Session': 123
},
'MessageConfiguration': {
'ADMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'APNSMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'BaiduMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'CustomMessage': {
'Data': 'string'
},
'DefaultMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'EmailMessage': {
'Body': 'string',
'FromAddress': 'string',
'HtmlBody': 'string',
'Title': 'string'
},
'GCMMessage': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageSmallIconUrl': 'string',
'ImageUrl': 'string',
'JsonBody': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'SilentPush': True|False,
'TimeToLive': 123,
'Title': 'string',
'Url': 'string'
},
'SMSMessage': {
'Body': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'InAppMessage': {
'Body': 'string',
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL'
}
},
'Name': 'string',
'Schedule': {
'EndTime': 'string',
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT'|'IN_APP_EVENT',
'IsLocalTime': True|False,
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'StartTime': 'string',
'Timezone': 'string'
},
'SegmentId': 'string',
'SegmentVersion': 123,
'State': {
'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'|'INVALID'
},
'tags': {
'string': 'string'
},
'TemplateConfiguration': {
'EmailTemplate': {
'Name': 'string',
'Version': 'string'
},
'PushTemplate': {
'Name': 'string',
'Version': 'string'
},
'SMSTemplate': {
'Name': 'string',
'Version': 'string'
},
'VoiceTemplate': {
'Name': 'string',
'Version': 'string'
}
},
'TreatmentDescription': 'string',
'TreatmentName': 'string',
'Version': 123,
'Priority': 123
}
}
Response Structure
(dict) --
The request succeeded.
CampaignResponse (dict) --
Provides information about the status, configuration, and other settings for a campaign.
AdditionalTreatments (list) --
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
(dict) --
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
Id (string) --
The unique identifier for the treatment.
MessageConfiguration (dict) --
The message configuration settings for the treatment.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
InAppMessage (dict) --
The in-app message configuration.
Body (string) --
The message body of the notification, the email body or the text message.
Content (list) --
In-app message content.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CustomConfig (dict) --
Custom config to be sent to client.
Layout (string) --
In-app message layout.
Schedule (dict) --
The schedule settings for the treatment.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SizePercent (integer) --
The allocated percentage of users (segment members) that the treatment is sent to.
State (dict) --
The current status of the treatment.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
TemplateConfiguration (dict) --
The message template to use for the treatment.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the treatment.
TreatmentName (string) --
The custom name of the treatment.
ApplicationId (string) --
The unique identifier for the application that the campaign applies to.
Arn (string) --
The Amazon Resource Name (ARN) of the campaign.
CreationDate (string) --
The date, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration (dict) --
The delivery configuration settings for sending the campaign through a custom channel.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
DefaultState (dict) --
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
Description (string) --
The custom description of the campaign.
HoldoutPercent (integer) --
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Hook (dict) --
The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
LambdaFunctionName (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode (string) --
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
WebUrl (string) --
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Id (string) --
The unique identifier for the campaign.
IsPaused (boolean) --
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the campaign was last modified.
Limits (dict) --
The messaging limits for the campaign.
Daily (integer) --
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
MaximumDuration (integer) --
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
MessagesPerSecond (integer) --
The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
Total (integer) --
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
Session (integer) --
The maximum total number of messages that the campaign can send per user session.
MessageConfiguration (dict) --
The message configuration settings for the campaign.
ADMMessage (dict) --
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSMessage (dict) --
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaiduMessage (dict) --
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
CustomMessage (dict) --
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
Data (string) --
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
DefaultMessage (dict) --
The default message that the campaign sends through all the channels that are configured for the campaign.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
EmailMessage (dict) --
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
Body (string) --
The body of the email for recipients whose email clients don't render HTML content.
FromAddress (string) --
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
HtmlBody (string) --
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Title (string) --
The subject line, or title, of the email.
GCMMessage (dict) --
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
Action (string) --
The action to occur if a recipient taps the push notification. Valid values are:
Body (string) --
The body of the notification message. The maximum number of characters is 200.
ImageIconUrl (string) --
The URL of the image to display as the push-notification icon, such as the icon for the app.
ImageSmallIconUrl (string) --
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
ImageUrl (string) --
The URL of an image to display in the push notification.
JsonBody (string) --
The JSON payload to use for a silent push notification.
MediaUrl (string) --
The URL of the image or video to display in the push notification.
RawContent (string) --
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush (boolean) --
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
TimeToLive (integer) --
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title (string) --
The title to display above the notification message on a recipient's device.
Url (string) --
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SMSMessage (dict) --
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
Body (string) --
The body of the SMS message.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display on recipients' devices when they receive the SMS message.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
InAppMessage (dict) --
The in-app message configuration.
Body (string) --
The message body of the notification, the email body or the text message.
Content (list) --
In-app message content.
(dict) --
The configuration for the message content.
BackgroundColor (string) --
The background color for the message.
BodyConfig (dict) --
The configuration for the message body.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Body (string) --
Message Body.
TextColor (string) --
The text color.
HeaderConfig (dict) --
The configuration for the message header.
Alignment (string) --
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Header (string) --
Message Header.
TextColor (string) --
The text color.
ImageUrl (string) --
The image url for the background of message.
PrimaryBtn (dict) --
The first button inside the message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
SecondaryBtn (dict) --
The second button inside message.
Android (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
DefaultConfig (dict) --
Default button content.
BackgroundColor (string) --
The background color of the button.
BorderRadius (integer) --
The border radius of the button.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Text (string) --
Button text.
TextColor (string) --
The text color of the button.
IOS (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
Web (dict) --
Default button content.
ButtonAction (string) --
Action triggered by the button.
Link (string) --
Button destination.
CustomConfig (dict) --
Custom config to be sent to client.
Layout (string) --
In-app message layout.
Name (string) --
The name of the campaign.
Schedule (dict) --
The schedule settings for the campaign.
EndTime (string) --
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
EventFilter (dict) --
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Dimensions (dict) --
The dimension settings of the event filter for the campaign.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Eventsresource) occurs.
Frequency (string) --
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime (boolean) --
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
QuietTime (dict) --
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
StartTime (string) --
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Timezone (string) --
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
SegmentId (string) --
The unique identifier for the segment that's associated with the campaign.
SegmentVersion (integer) --
The version number of the segment that's associated with the campaign.
State (dict) --
The current status of the campaign.
CampaignStatus (string) --
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
TemplateConfiguration (dict) --
The message template that’s used for the campaign.
EmailTemplate (dict) --
The email template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
PushTemplate (dict) --
The push notification template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
SMSTemplate (dict) --
The SMS template to use for the message.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
VoiceTemplate (dict) --
The voice template to use for the message. This object isn't supported for campaigns.
Name (string) --
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Version (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TreatmentDescription (string) --
The custom description of the default treatment for the campaign.
TreatmentName (string) --
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Version (integer) --
The version number of the campaign.
Priority (integer) --
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_email_channel(**kwargs)¶Enables the email channel for an application or updates the status and settings of the email channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_email_channel(
ApplicationId='string',
EmailChannelRequest={
'ConfigurationSet': 'string',
'Enabled': True|False,
'FromAddress': 'string',
'Identity': 'string',
'RoleArn': 'string'
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the status and settings of the email channel for an application.
The Amazon SES configuration set that you want to apply to messages that you send through the channel.
Specifies whether to enable the email channel for the application.
The verified email address that you want to send email from when you send email through the channel.
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.
The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.
dict
Response Syntax
{
'EmailChannelResponse': {
'ApplicationId': 'string',
'ConfigurationSet': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'FromAddress': 'string',
'HasCredential': True|False,
'Id': 'string',
'Identity': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'MessagesPerSecond': 123,
'Platform': 'string',
'RoleArn': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
EmailChannelResponse (dict) --
Provides information about the status and settings of the email channel for an application.
ApplicationId (string) --
The unique identifier for the application that the email channel applies to.
ConfigurationSet (string) --
The Amazon SES configuration set that's applied to messages that are sent through the channel.
CreationDate (string) --
The date and time, in ISO 8601 format, when the email channel was enabled.
Enabled (boolean) --
Specifies whether the email channel is enabled for the application.
FromAddress (string) --
The verified email address that email is sent from when you send email through the channel.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
Id (string) --
(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
Identity (string) --
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.
IsArchived (boolean) --
Specifies whether the email channel is archived.
LastModifiedBy (string) --
The user who last modified the email channel.
LastModifiedDate (string) --
The date and time, in ISO 8601 format, when the email channel was last modified.
MessagesPerSecond (integer) --
The maximum number of emails that can be sent through the channel each second.
Platform (string) --
The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
RoleArn (string) --
The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
Version (integer) --
The current version of the email channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_email_template(**kwargs)¶Updates an existing message template for messages that are sent through the email channel.
See also: AWS API Documentation
Request Syntax
response = client.update_email_template(
CreateNewVersion=True|False,
EmailTemplateRequest={
'DefaultSubstitutions': 'string',
'HtmlPart': 'string',
'RecommenderId': 'string',
'Subject': 'string',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string',
'TextPart': 'string'
},
TemplateName='string',
Version='string'
)
Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
[REQUIRED]
Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.
A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
The subject line, or title, to use in email messages that are based on the message template.
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
A custom description of the message template.
The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_endpoint(**kwargs)¶Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
See also: AWS API Documentation
Request Syntax
response = client.update_endpoint(
ApplicationId='string',
EndpointId='string',
EndpointRequest={
'Address': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the endpoint.
[REQUIRED]
Specifies the channel type and other settings for an endpoint.
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
The channel to use when sending messages or push notifications to the endpoint.
The demographic information for the endpoint, such as the time zone and platform.
The version of the app that's associated with the endpoint.
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
The manufacturer of the endpoint device, such as apple or samsung.
The model name or number of the endpoint device, such as iPhone or SM-G900F.
The model version of the endpoint device.
The platform of the endpoint device, such as ios.
The platform version of the endpoint device.
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
The date and time, in ISO 8601 format, when the endpoint is updated.
Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
The geographic information for the endpoint.
The name of the city where the endpoint is located.
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
The latitude coordinate of the endpoint location, rounded to one decimal place.
The longitude coordinate of the endpoint location, rounded to one decimal place.
The postal or ZIP code for the area where the endpoint is located.
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
The unique identifier for the most recent request to update the endpoint.
One or more custom attributes that describe the user who's associated with the endpoint.
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
The unique identifier for the user.
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_endpoints_batch(**kwargs)¶Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
See also: AWS API Documentation
Request Syntax
response = client.update_endpoints_batch(
ApplicationId='string',
EndpointBatchRequest={
'Item': [
{
'Address': 'string',
'Attributes': {
'string': [
'string',
]
},
'ChannelType': 'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
'Demographic': {
'AppVersion': 'string',
'Locale': 'string',
'Make': 'string',
'Model': 'string',
'ModelVersion': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'Timezone': 'string'
},
'EffectiveDate': 'string',
'EndpointStatus': 'string',
'Id': 'string',
'Location': {
'City': 'string',
'Country': 'string',
'Latitude': 123.0,
'Longitude': 123.0,
'PostalCode': 'string',
'Region': 'string'
},
'Metrics': {
'string': 123.0
},
'OptOut': 'string',
'RequestId': 'string',
'User': {
'UserAttributes': {
'string': [
'string',
]
},
'UserId': 'string'
}
},
]
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.
An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items.
Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
The channel to use when sending messages or push notifications to the endpoint.
The demographic information for the endpoint, such as the time zone and platform.
The version of the app that's associated with the endpoint.
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
The manufacturer of the endpoint device, such as apple or samsung.
The model name or number of the endpoint device, such as iPhone or SM-G900F.
The model version of the endpoint device.
The platform of the endpoint device, such as ios.
The platform version of the endpoint device.
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
The date and time, in ISO 8601 format, when the endpoint was created or updated.
Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
The unique identifier for the endpoint in the context of the batch.
The geographic information for the endpoint.
The name of the city where the endpoint is located.
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
The latitude coordinate of the endpoint location, rounded to one decimal place.
The longitude coordinate of the endpoint location, rounded to one decimal place.
The postal or ZIP code for the area where the endpoint is located.
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
The unique identifier for the request to create or update the endpoint.
One or more custom attributes that describe the user who's associated with the endpoint.
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
The unique identifier for the user.
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_gcm_channel(**kwargs)¶Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_gcm_channel(
ApplicationId='string',
GCMChannelRequest={
'ApiKey': 'string',
'Enabled': True|False
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
The Web API Key, also referred to as an API_KEY or server key , that you received from Google to communicate with Google services.
Specifies whether to enable the GCM channel for the application.
dict
Response Syntax
{
'GCMChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Credential': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
GCMChannelResponse (dict) --
Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
ApplicationId (string) --
The unique identifier for the application that the GCM channel applies to.
CreationDate (string) --
The date and time when the GCM channel was enabled.
Credential (string) --
The Web API Key, also referred to as an API_KEY or server key , that you received from Google to communicate with Google services.
Enabled (boolean) --
Specifies whether the GCM channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
Id (string) --
(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the GCM channel is archived.
LastModifiedBy (string) --
The user who last modified the GCM channel.
LastModifiedDate (string) --
The date and time when the GCM channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.
Version (integer) --
The current version of the GCM channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_in_app_template(**kwargs)¶Updates an existing message template for messages sent through the in-app message channel.
See also: AWS API Documentation
Request Syntax
response = client.update_in_app_template(
CreateNewVersion=True|False,
InAppTemplateRequest={
'Content': [
{
'BackgroundColor': 'string',
'BodyConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Body': 'string',
'TextColor': 'string'
},
'HeaderConfig': {
'Alignment': 'LEFT'|'CENTER'|'RIGHT',
'Header': 'string',
'TextColor': 'string'
},
'ImageUrl': 'string',
'PrimaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
},
'SecondaryBtn': {
'Android': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'DefaultConfig': {
'BackgroundColor': 'string',
'BorderRadius': 123,
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string',
'Text': 'string',
'TextColor': 'string'
},
'IOS': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
},
'Web': {
'ButtonAction': 'LINK'|'DEEP_LINK'|'CLOSE',
'Link': 'string'
}
}
},
],
'CustomConfig': {
'string': 'string'
},
'Layout': 'BOTTOM_BANNER'|'TOP_BANNER'|'OVERLAYS'|'MOBILE_FEED'|'MIDDLE_BANNER'|'CAROUSEL',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string'
},
TemplateName='string',
Version='string'
)
Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
[REQUIRED]
InApp Template Request.
The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
The configuration for the message content.
The background color for the message.
The configuration for the message body.
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Message Body.
The text color.
The configuration for the message header.
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
Message Header.
The text color.
The image url for the background of message.
The first button inside the message.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
The background color of the button.
The border radius of the button.
Action triggered by the button.
Button destination.
Button text.
The text color of the button.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
Action triggered by the button.
Button destination.
The second button inside message.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
The background color of the button.
The border radius of the button.
Action triggered by the button.
Button destination.
Button text.
The text color of the button.
Default button content.
Action triggered by the button.
Button destination.
Default button content.
Action triggered by the button.
Button destination.
Custom config to be sent to client.
The layout of the message.
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
The description of the template.
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_journey(**kwargs)¶Updates the configuration and other settings for a journey.
See also: AWS API Documentation
Request Syntax
response = client.update_journey(
ApplicationId='string',
JourneyId='string',
WriteJourneyRequest={
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'ContactCenter': {
'NextActivity': 'string'
}
}
},
'CreationDate': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123,
'EndpointReentryInterval': 'string'
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED'|'PAUSED',
'WaitForQuietTime': True|False,
'RefreshOnSegmentUpdate': True|False,
'JourneyChannelSettings': {
'ConnectCampaignArn': 'string',
'ConnectCampaignExecutionRoleArn': 'string'
},
'SendingSchedule': True|False,
'OpenHours': {
'EMAIL': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'SMS': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'PUSH': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'VOICE': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'CUSTOM': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
}
},
'ClosedDays': {
'EMAIL': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'SMS': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'PUSH': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'VOICE': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'CUSTOM': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
]
}
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the journey.
[REQUIRED]
Specifies the configuration and other settings for a journey.
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.
Specifies the configuration and other settings for an activity in a journey.
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
The destination to send the campaign or treatment to. This value can be one of the following:
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
Specifies the message data included in a custom channel message that's sent to participants in a journey.
The message content that's passed to an AWS Lambda function or to a web hook.
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
The conditions that define the paths for the activity, and the relationship between the conditions.
The conditions to evaluate for the activity.
Specifies a condition to evaluate for an activity in a journey.
The dimension settings for the event that's associated with the activity.
The dimensions for the event filter to use for the activity.
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
The segment that's associated with the activity.
The unique identifier for the segment to associate with the activity.
The dimension settings for the segment that's associated with the activity.
One or more custom attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The behavior-based criteria, such as how recently users have used your app, for the segment.
The dimension settings that are based on how recently an endpoint was active.
The duration to use when determining whether an endpoint is active or inactive.
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
The demographic-based criteria, such as device platform, for the segment.
The app version criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The channel criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device type criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device make criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device model criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device platform criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The location-based criteria, such as region or GPS coordinates, for the segment.
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The GPS location and range for the segment.
The GPS coordinates to measure distance from.
The latitude coordinate of the location.
The longitude coordinate of the location.
The range, in kilometers, from the GPS coordinates.
One or more custom metrics to use as criteria for the segment.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
One or more custom user attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
The unique identifier for the activity to perform if the conditions aren't met.
The unique identifier for the activity to perform if the conditions are met.
The custom description of the activity.
The settings for an email activity. This type of activity sends an email message to participants.
Specifies the sender address for an email message that's sent to participants in the journey.
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
The unique identifier for the next activity to perform, after the message is sent.
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
The unique identifier for the next activity to perform, after performing the holdout activity.
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
Specifies a condition to evaluate for an activity path in a journey.
The condition to evaluate for the activity path.
The dimension settings for the event that's associated with the activity.
The dimensions for the event filter to use for the activity.
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
The segment that's associated with the activity.
The unique identifier for the segment to associate with the activity.
The dimension settings for the segment that's associated with the activity.
One or more custom attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The behavior-based criteria, such as how recently users have used your app, for the segment.
The dimension settings that are based on how recently an endpoint was active.
The duration to use when determining whether an endpoint is active or inactive.
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
The demographic-based criteria, such as device platform, for the segment.
The app version criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The channel criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device type criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device make criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device model criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device platform criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The location-based criteria, such as region or GPS coordinates, for the segment.
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The GPS location and range for the segment.
The GPS coordinates to measure distance from.
The latitude coordinate of the location.
The longitude coordinate of the location.
The range, in kilometers, from the GPS coordinates.
One or more custom metrics to use as criteria for the segment.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
One or more custom user attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The unique identifier for the next activity to perform, after completing the activity for the path.
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
The settings for a push notification activity. This type of activity sends a push notification to participants.
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
The unique identifier for the next activity to perform, after the message is sent.
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
Specifies the settings for a path in a random split activity in a journey.
The unique identifier for the next activity to perform, after completing the activity for the path.
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
The settings for an SMS activity. This type of activity sends a text message to participants.
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
The template ID received from the regulatory body for sending SMS in your country.
The unique identifier for the next activity to perform, after the message is sent.
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
The unique identifier for the next activity to perform, after performing the wait activity.
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
The settings for a connect activity. This type of activity initiates a contact center call to participants.
The unique identifier for the next activity to perform after the this activity.
The date, in ISO 8601 format, when the journey was created.
The date, in ISO 8601 format, when the journey was last modified.
The messaging and entry limits for the journey.
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
The maximum number of messages that the journey can send each second.
Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.
Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.
The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
The schedule settings for the journey.
The scheduled time, in ISO 8601 format, when the journey ended or will end.
The scheduled time, in ISO 8601 format, when the journey began or will begin.
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.
The segment that defines which users are participants in the journey.
The custom description of the condition.
Specifies the settings for an event that causes a journey activity to start.
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
The dimensions for the event filter to use for the campaign or the journey activity.
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
The unique identifier for the segment to associate with the activity.
The status of the journey. Valid values are:
PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the Journey Stateresource.
Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
Specifies whether a journey should be refreshed on segment update.
The channel-specific configurations for the journey.
Amazon Resource Name (ARN) of the Connect Campaign.
IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)
The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
Rules for Email Channel.
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
Open Hour Rules.
Open Hour Rule Details.
Local start time in ISO 8601 format.
Local start time in ISO 8601 format.
Rules for SMS Channel.
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
Open Hour Rules.
Open Hour Rule Details.
Local start time in ISO 8601 format.
Local start time in ISO 8601 format.
Rules for Push Channel.
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
Open Hour Rules.
Open Hour Rule Details.
Local start time in ISO 8601 format.
Local start time in ISO 8601 format.
Rules for Voice Channel.
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
Open Hour Rules.
Open Hour Rule Details.
Local start time in ISO 8601 format.
Local start time in ISO 8601 format.
Rules for Custom Channel.
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
Open Hour Rules.
Open Hour Rule Details.
Local start time in ISO 8601 format.
Local start time in ISO 8601 format.
The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.
Rules for Email Channel.
ClosedDays rule details.
Name of the rule.
Start Datetime in ISO 8601 format.
End Datetime in ISO 8601 format.
Rules for SMS Channel.
ClosedDays rule details.
Name of the rule.
Start Datetime in ISO 8601 format.
End Datetime in ISO 8601 format.
Rules for Push Channel.
ClosedDays rule details.
Name of the rule.
Start Datetime in ISO 8601 format.
End Datetime in ISO 8601 format.
Rules for Voice Channel.
ClosedDays rule details.
Name of the rule.
Start Datetime in ISO 8601 format.
End Datetime in ISO 8601 format.
Rules for Custom Channel.
ClosedDays rule details.
Name of the rule.
Start Datetime in ISO 8601 format.
End Datetime in ISO 8601 format.
dict
Response Syntax
{
'JourneyResponse': {
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'ContactCenter': {
'NextActivity': 'string'
}
}
},
'ApplicationId': 'string',
'CreationDate': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123,
'EndpointReentryInterval': 'string'
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED'|'PAUSED',
'tags': {
'string': 'string'
},
'WaitForQuietTime': True|False,
'RefreshOnSegmentUpdate': True|False,
'JourneyChannelSettings': {
'ConnectCampaignArn': 'string',
'ConnectCampaignExecutionRoleArn': 'string'
},
'SendingSchedule': True|False,
'OpenHours': {
'EMAIL': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'SMS': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'PUSH': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'VOICE': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'CUSTOM': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
}
},
'ClosedDays': {
'EMAIL': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'SMS': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'PUSH': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'VOICE': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'CUSTOM': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
]
}
}
}
Response Structure
(dict) --
The request succeeded.
JourneyResponse (dict) --
Provides information about the status, configuration, and other settings for a journey.
Activities (dict) --
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
(string) --
(dict) --
Specifies the configuration and other settings for an activity in a journey.
CUSTOM (dict) --
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
MessageConfig (dict) --
Specifies the message data included in a custom channel message that's sent to participants in a journey.
Data (string) --
The message content that's passed to an AWS Lambda function or to a web hook.
NextActivity (string) --
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
TemplateName (string) --
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
ConditionalSplit (dict) --
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
Condition (dict) --
The conditions that define the paths for the activity, and the relationship between the conditions.
Conditions (list) --
The conditions to evaluate for the activity.
(dict) --
Specifies a condition to evaluate for an activity in a journey.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Operator (string) --
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
EvaluationWaitTime (dict) --
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
FalseActivity (string) --
The unique identifier for the activity to perform if the conditions aren't met.
TrueActivity (string) --
The unique identifier for the activity to perform if the conditions are met.
Description (string) --
The custom description of the activity.
EMAIL (dict) --
The settings for an email activity. This type of activity sends an email message to participants.
MessageConfig (dict) --
Specifies the sender address for an email message that's sent to participants in the journey.
FromAddress (string) --
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Holdout (dict) --
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the holdout activity.
Percentage (integer) --
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
MultiCondition (dict) --
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
(dict) --
Specifies a condition to evaluate for an activity path in a journey.
Condition (dict) --
The condition to evaluate for the activity path.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
DefaultActivity (string) --
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
EvaluationWaitTime (dict) --
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
PUSH (dict) --
The settings for a push notification activity. This type of activity sends a push notification to participants.
MessageConfig (dict) --
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
TimeToLive (string) --
The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
RandomSplit (dict) --
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
(dict) --
Specifies the settings for a path in a random split activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
Percentage (integer) --
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
SMS (dict) --
The settings for an SMS activity. This type of activity sends a text message to participants.
MessageConfig (dict) --
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Wait (dict) --
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the wait activity.
WaitTime (dict) --
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
ContactCenter (dict) --
The settings for a connect activity. This type of activity initiates a contact center call to participants.
NextActivity (string) --
The unique identifier for the next activity to perform after the this activity.
ApplicationId (string) --
The unique identifier for the application that the journey applies to.
CreationDate (string) --
The date, in ISO 8601 format, when the journey was created.
Id (string) --
The unique identifier for the journey.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the journey was last modified.
Limits (dict) --
The messaging and entry limits for the journey.
DailyCap (integer) --
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
EndpointReentryCap (integer) --
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
MessagesPerSecond (integer) --
The maximum number of messages that the journey can send each second.
EndpointReentryInterval (string) --
Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.
LocalTime (boolean) --
Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
Name (string) --
The name of the journey.
QuietTime (dict) --
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
RefreshFrequency (string) --
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Schedule (dict) --
The schedule settings for the journey.
EndTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey ended or will end.
StartTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey began or will begin.
Timezone (string) --
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
StartActivity (string) --
The unique identifier for the first activity in the journey.
StartCondition (dict) --
The segment that defines which users are participants in the journey.
Description (string) --
The custom description of the condition.
EventStartCondition (dict) --
Specifies the settings for an event that causes a journey activity to start.
EventFilter (dict) --
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Dimensions (dict) --
The dimensions for the event filter to use for the campaign or the journey activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
SegmentId (string) --
SegmentStartCondition (dict) --
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
State (string) --
The current status of the journey. Possible values are:
tags (dict) --
This object is not used or supported.
WaitForQuietTime (boolean) --
Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
RefreshOnSegmentUpdate (boolean) --
Specifies whether a journey should be refreshed on segment update.
JourneyChannelSettings (dict) --
The channel-specific configurations for the journey.
ConnectCampaignArn (string) --
Amazon Resource Name (ARN) of the Connect Campaign.
ConnectCampaignExecutionRoleArn (string) --
IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
SendingSchedule (boolean) --
Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)
OpenHours (dict) --
The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
EMAIL (dict) --
Rules for Email Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
SMS (dict) --
Rules for SMS Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
PUSH (dict) --
Rules for Push Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
VOICE (dict) --
Rules for Voice Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
CUSTOM (dict) --
Rules for Custom Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
ClosedDays (dict) --
The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.
EMAIL (list) --
Rules for Email Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
SMS (list) --
Rules for SMS Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
PUSH (list) --
Rules for Push Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
VOICE (list) --
Rules for Voice Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
CUSTOM (list) --
Rules for Custom Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionPinpoint.Client.exceptions.ConflictExceptionupdate_journey_state(**kwargs)¶Cancels (stops) an active journey.
See also: AWS API Documentation
Request Syntax
response = client.update_journey_state(
ApplicationId='string',
JourneyId='string',
JourneyStateRequest={
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED'|'PAUSED'
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the journey.
[REQUIRED]
Changes the status of a journey.
The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED
If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.
After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.
When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.
dict
Response Syntax
{
'JourneyResponse': {
'Activities': {
'string': {
'CUSTOM': {
'DeliveryUri': 'string',
'EndpointTypes': [
'PUSH'|'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'VOICE'|'EMAIL'|'BAIDU'|'CUSTOM'|'IN_APP',
],
'MessageConfig': {
'Data': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'ConditionalSplit': {
'Condition': {
'Conditions': [
{
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
],
'Operator': 'ALL'|'ANY'
},
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
},
'FalseActivity': 'string',
'TrueActivity': 'string'
},
'Description': 'string',
'EMAIL': {
'MessageConfig': {
'FromAddress': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Holdout': {
'NextActivity': 'string',
'Percentage': 123
},
'MultiCondition': {
'Branches': [
{
'Condition': {
'EventCondition': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'MessageActivity': 'string'
},
'SegmentCondition': {
'SegmentId': 'string'
},
'SegmentDimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
}
},
'NextActivity': 'string'
},
],
'DefaultActivity': 'string',
'EvaluationWaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'PUSH': {
'MessageConfig': {
'TimeToLive': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'RandomSplit': {
'Branches': [
{
'NextActivity': 'string',
'Percentage': 123
},
]
},
'SMS': {
'MessageConfig': {
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'OriginationNumber': 'string',
'SenderId': 'string',
'EntityId': 'string',
'TemplateId': 'string'
},
'NextActivity': 'string',
'TemplateName': 'string',
'TemplateVersion': 'string'
},
'Wait': {
'NextActivity': 'string',
'WaitTime': {
'WaitFor': 'string',
'WaitUntil': 'string'
}
},
'ContactCenter': {
'NextActivity': 'string'
}
}
},
'ApplicationId': 'string',
'CreationDate': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Limits': {
'DailyCap': 123,
'EndpointReentryCap': 123,
'MessagesPerSecond': 123,
'EndpointReentryInterval': 'string'
},
'LocalTime': True|False,
'Name': 'string',
'QuietTime': {
'End': 'string',
'Start': 'string'
},
'RefreshFrequency': 'string',
'Schedule': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'Timezone': 'string'
},
'StartActivity': 'string',
'StartCondition': {
'Description': 'string',
'EventStartCondition': {
'EventFilter': {
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'EventType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
}
},
'FilterType': 'SYSTEM'|'ENDPOINT'
},
'SegmentId': 'string'
},
'SegmentStartCondition': {
'SegmentId': 'string'
}
},
'State': 'DRAFT'|'ACTIVE'|'COMPLETED'|'CANCELLED'|'CLOSED'|'PAUSED',
'tags': {
'string': 'string'
},
'WaitForQuietTime': True|False,
'RefreshOnSegmentUpdate': True|False,
'JourneyChannelSettings': {
'ConnectCampaignArn': 'string',
'ConnectCampaignExecutionRoleArn': 'string'
},
'SendingSchedule': True|False,
'OpenHours': {
'EMAIL': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'SMS': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'PUSH': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'VOICE': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
},
'CUSTOM': {
'string': [
{
'StartTime': 'string',
'EndTime': 'string'
},
]
}
},
'ClosedDays': {
'EMAIL': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'SMS': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'PUSH': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'VOICE': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
],
'CUSTOM': [
{
'Name': 'string',
'StartDateTime': 'string',
'EndDateTime': 'string'
},
]
}
}
}
Response Structure
(dict) --
The request succeeded.
JourneyResponse (dict) --
Provides information about the status, configuration, and other settings for a journey.
Activities (dict) --
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
(string) --
(dict) --
Specifies the configuration and other settings for an activity in a journey.
CUSTOM (dict) --
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
DeliveryUri (string) --
The destination to send the campaign or treatment to. This value can be one of the following:
EndpointTypes (list) --
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
MessageConfig (dict) --
Specifies the message data included in a custom channel message that's sent to participants in a journey.
Data (string) --
The message content that's passed to an AWS Lambda function or to a web hook.
NextActivity (string) --
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
TemplateName (string) --
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
ConditionalSplit (dict) --
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
Condition (dict) --
The conditions that define the paths for the activity, and the relationship between the conditions.
Conditions (list) --
The conditions to evaluate for the activity.
(dict) --
Specifies a condition to evaluate for an activity in a journey.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Operator (string) --
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
EvaluationWaitTime (dict) --
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
FalseActivity (string) --
The unique identifier for the activity to perform if the conditions aren't met.
TrueActivity (string) --
The unique identifier for the activity to perform if the conditions are met.
Description (string) --
The custom description of the activity.
EMAIL (dict) --
The settings for an email activity. This type of activity sends an email message to participants.
MessageConfig (dict) --
Specifies the sender address for an email message that's sent to participants in the journey.
FromAddress (string) --
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Holdout (dict) --
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the holdout activity.
Percentage (integer) --
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
MultiCondition (dict) --
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
(dict) --
Specifies a condition to evaluate for an activity path in a journey.
Condition (dict) --
The condition to evaluate for the activity path.
EventCondition (dict) --
The dimension settings for the event that's associated with the activity.
Dimensions (dict) --
The dimensions for the event filter to use for the activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
MessageActivity (string) --
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
SegmentCondition (dict) --
The segment that's associated with the activity.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
SegmentDimensions (dict) --
The dimension settings for the segment that's associated with the activity.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
DefaultActivity (string) --
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
EvaluationWaitTime (dict) --
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
PUSH (dict) --
The settings for a push notification activity. This type of activity sends a push notification to participants.
MessageConfig (dict) --
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
TimeToLive (string) --
The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
RandomSplit (dict) --
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
Branches (list) --
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
(dict) --
Specifies the settings for a path in a random split activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after completing the activity for the path.
Percentage (integer) --
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
SMS (dict) --
The settings for an SMS activity. This type of activity sends a text message to participants.
MessageConfig (dict) --
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
MessageType (string) --
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
OriginationNumber (string) --
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
SenderId (string) --
The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
EntityId (string) --
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
TemplateId (string) --
The template ID received from the regulatory body for sending SMS in your country.
NextActivity (string) --
The unique identifier for the next activity to perform, after the message is sent.
TemplateName (string) --
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
TemplateVersion (string) --
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Wait (dict) --
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
NextActivity (string) --
The unique identifier for the next activity to perform, after performing the wait activity.
WaitTime (dict) --
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitFor (string) --
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
WaitUntil (string) --
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
ContactCenter (dict) --
The settings for a connect activity. This type of activity initiates a contact center call to participants.
NextActivity (string) --
The unique identifier for the next activity to perform after the this activity.
ApplicationId (string) --
The unique identifier for the application that the journey applies to.
CreationDate (string) --
The date, in ISO 8601 format, when the journey was created.
Id (string) --
The unique identifier for the journey.
LastModifiedDate (string) --
The date, in ISO 8601 format, when the journey was last modified.
Limits (dict) --
The messaging and entry limits for the journey.
DailyCap (integer) --
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
EndpointReentryCap (integer) --
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
MessagesPerSecond (integer) --
The maximum number of messages that the journey can send each second.
EndpointReentryInterval (string) --
Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.
LocalTime (boolean) --
Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
Name (string) --
The name of the journey.
QuietTime (dict) --
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
End (string) --
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Start (string) --
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
RefreshFrequency (string) --
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
Schedule (dict) --
The schedule settings for the journey.
EndTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey ended or will end.
StartTime (datetime) --
The scheduled time, in ISO 8601 format, when the journey began or will begin.
Timezone (string) --
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
StartActivity (string) --
The unique identifier for the first activity in the journey.
StartCondition (dict) --
The segment that defines which users are participants in the journey.
Description (string) --
The custom description of the condition.
EventStartCondition (dict) --
Specifies the settings for an event that causes a journey activity to start.
EventFilter (dict) --
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Dimensions (dict) --
The dimensions for the event filter to use for the campaign or the journey activity.
Attributes (dict) --
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
EventType (dict) --
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Metrics (dict) --
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
FilterType (string) --
The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
SegmentId (string) --
SegmentStartCondition (dict) --
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
SegmentId (string) --
The unique identifier for the segment to associate with the activity.
State (string) --
The current status of the journey. Possible values are:
tags (dict) --
This object is not used or supported.
WaitForQuietTime (boolean) --
Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
RefreshOnSegmentUpdate (boolean) --
Specifies whether a journey should be refreshed on segment update.
JourneyChannelSettings (dict) --
The channel-specific configurations for the journey.
ConnectCampaignArn (string) --
Amazon Resource Name (ARN) of the Connect Campaign.
ConnectCampaignExecutionRoleArn (string) --
IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
SendingSchedule (boolean) --
Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)
OpenHours (dict) --
The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
EMAIL (dict) --
Rules for Email Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
SMS (dict) --
Rules for SMS Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
PUSH (dict) --
Rules for Push Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
VOICE (dict) --
Rules for Voice Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
CUSTOM (dict) --
Rules for Custom Channel.
(string) --
Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
(list) --
Open Hour Rules.
(dict) --
Open Hour Rule Details.
StartTime (string) --
Local start time in ISO 8601 format.
EndTime (string) --
Local start time in ISO 8601 format.
ClosedDays (dict) --
The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.
EMAIL (list) --
Rules for Email Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
SMS (list) --
Rules for SMS Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
PUSH (list) --
Rules for Push Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
VOICE (list) --
Rules for Voice Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
CUSTOM (list) --
Rules for Custom Channel.
(dict) --
ClosedDays rule details.
Name (string) --
Name of the rule.
StartDateTime (string) --
Start Datetime in ISO 8601 format.
EndDateTime (string) --
End Datetime in ISO 8601 format.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_push_template(**kwargs)¶Updates an existing message template for messages that are sent through a push notification channel.
See also: AWS API Documentation
Request Syntax
response = client.update_push_template(
CreateNewVersion=True|False,
PushNotificationTemplateRequest={
'ADM': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'APNS': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'MediaUrl': 'string',
'RawContent': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'Baidu': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'Default': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'DefaultSubstitutions': 'string',
'GCM': {
'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
'Body': 'string',
'ImageIconUrl': 'string',
'ImageUrl': 'string',
'RawContent': 'string',
'SmallImageIconUrl': 'string',
'Sound': 'string',
'Title': 'string',
'Url': 'string'
},
'RecommenderId': 'string',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string'
},
TemplateName='string',
Version='string'
)
Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
[REQUIRED]
Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.
The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
The message body to use in a push notification that's based on the message template.
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
The URL of an image to display in a push notification that's based on the message template.
The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
The message body to use in push notifications that are based on the message template.
The URL of an image or video to display in push notifications that are based on the message template.
The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.
The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
The message body to use in a push notification that's based on the message template.
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
The URL of an image to display in a push notification that's based on the message template.
The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
The default message template to use for push notification channels.
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
The message body to use in push notifications that are based on the message template.
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
The message body to use in a push notification that's based on the message template.
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
The URL of an image to display in a push notification that's based on the message template.
The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
A custom description of the message template.
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_recommender_configuration(**kwargs)¶Updates an Amazon Pinpoint configuration for a recommender model.
See also: AWS API Documentation
Request Syntax
response = client.update_recommender_configuration(
RecommenderId='string',
UpdateRecommenderConfiguration={
'Attributes': {
'string': 'string'
},
'Description': 'string',
'Name': 'string',
'RecommendationProviderIdType': 'string',
'RecommendationProviderRoleArn': 'string',
'RecommendationProviderUri': 'string',
'RecommendationTransformerUri': 'string',
'RecommendationsDisplayName': 'string',
'RecommendationsPerMessage': 123
}
)
[REQUIRED]
The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:
This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.
A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.
A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.
The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.
A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.
To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
dict
Response Syntax
{
'RecommenderConfigurationResponse': {
'Attributes': {
'string': 'string'
},
'CreationDate': 'string',
'Description': 'string',
'Id': 'string',
'LastModifiedDate': 'string',
'Name': 'string',
'RecommendationProviderIdType': 'string',
'RecommendationProviderRoleArn': 'string',
'RecommendationProviderUri': 'string',
'RecommendationTransformerUri': 'string',
'RecommendationsDisplayName': 'string',
'RecommendationsPerMessage': 123
}
}
Response Structure
(dict) --
The request succeeded.
RecommenderConfigurationResponse (dict) --
Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
Attributes (dict) --
A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
CreationDate (string) --
The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
Description (string) --
The custom description of the configuration for the recommender model.
Id (string) --
The unique identifier for the recommender model configuration.
LastModifiedDate (string) --
The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
Name (string) --
The custom name of the configuration for the recommender model.
RecommendationProviderIdType (string) --
The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:
RecommendationProviderRoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
RecommendationProviderUri (string) --
The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.
RecommendationTransformerUri (string) --
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.
RecommendationsDisplayName (string) --
The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
RecommendationsPerMessage (integer) --
The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_segment(**kwargs)¶Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
See also: AWS API Documentation
Request Syntax
response = client.update_segment(
ApplicationId='string',
SegmentId='string',
WriteSegmentRequest={
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'tags': {
'string': 'string'
}
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
The unique identifier for the segment.
[REQUIRED]
Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.
The criteria that define the dimensions for the segment.
One or more custom attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The behavior-based criteria, such as how recently users have used your app, for the segment.
The dimension settings that are based on how recently an endpoint was active.
The duration to use when determining whether an endpoint is active or inactive.
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
The demographic-based criteria, such as device platform, for the segment.
The app version criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The channel criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device type criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device make criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device model criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device platform criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The location-based criteria, such as region or GPS coordinates, for the segment.
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The GPS location and range for the segment.
The GPS coordinates to measure distance from.
The latitude coordinate of the location.
The longitude coordinate of the location.
The range, in kilometers, from the GPS coordinates.
One or more custom metrics to use as criteria for the segment.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
One or more custom user attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The name of the segment.
The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
An array that defines the dimensions for the segment.
Specifies the dimension settings for a segment.
One or more custom attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The behavior-based criteria, such as how recently users have used your app, for the segment.
The dimension settings that are based on how recently an endpoint was active.
The duration to use when determining whether an endpoint is active or inactive.
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
The demographic-based criteria, such as device platform, for the segment.
The app version criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The channel criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device type criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device make criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device model criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The device platform criteria for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The location-based criteria, such as region or GPS coordinates, for the segment.
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
The GPS location and range for the segment.
The GPS coordinates to measure distance from.
The latitude coordinate of the location.
The longitude coordinate of the location.
The range, in kilometers, from the GPS coordinates.
One or more custom metrics to use as criteria for the segment.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
The value to compare.
One or more custom user attributes to use as criteria for the segment.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
The type of segment dimension to use. Valid values are:
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
Specifies the segment identifier and version of a segment.
The unique identifier for the segment.
The version number of the segment.
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.
dict
Response Syntax
{
'SegmentResponse': {
'ApplicationId': 'string',
'Arn': 'string',
'CreationDate': 'string',
'Dimensions': {
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
'Id': 'string',
'ImportDefinition': {
'ChannelCounts': {
'string': 123
},
'ExternalId': 'string',
'Format': 'CSV'|'JSON',
'RoleArn': 'string',
'S3Url': 'string',
'Size': 123
},
'LastModifiedDate': 'string',
'Name': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'Attributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
},
'Behavior': {
'Recency': {
'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
'RecencyType': 'ACTIVE'|'INACTIVE'
}
},
'Demographic': {
'AppVersion': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Channel': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'DeviceType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Make': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Model': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'Platform': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
}
},
'Location': {
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'string',
]
},
'GPSPoint': {
'Coordinates': {
'Latitude': 123.0,
'Longitude': 123.0
},
'RangeInKilometers': 123.0
}
},
'Metrics': {
'string': {
'ComparisonOperator': 'string',
'Value': 123.0
}
},
'UserAttributes': {
'string': {
'AttributeType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEFORE'|'AFTER'|'ON'|'BETWEEN',
'Values': [
'string',
]
}
}
},
],
'SourceSegments': [
{
'Id': 'string',
'Version': 123
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentType': 'DIMENSIONAL'|'IMPORT',
'tags': {
'string': 'string'
},
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
SegmentResponse (dict) --
Provides information about the configuration, dimension, and other settings for a segment.
ApplicationId (string) --
The unique identifier for the application that the segment is associated with.
Arn (string) --
The Amazon Resource Name (ARN) of the segment.
CreationDate (string) --
The date and time when the segment was created.
Dimensions (dict) --
The dimension settings for the segment.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Id (string) --
The unique identifier for the segment.
ImportDefinition (dict) --
The settings for the import job that's associated with the segment.
ChannelCounts (dict) --
The number of channel types in the endpoint definitions that were imported to create the segment.
ExternalId (string) --
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
Format (string) --
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
RoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
S3Url (string) --
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Size (integer) --
The number of endpoint definitions that were imported successfully to create the segment.
LastModifiedDate (string) --
The date and time when the segment was last modified.
Name (string) --
The name of the segment.
SegmentGroups (dict) --
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
Groups (list) --
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
(dict) --
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Dimensions (list) --
An array that defines the dimensions for the segment.
(dict) --
Specifies the dimension settings for a segment.
Attributes (dict) --
One or more custom attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Behavior (dict) --
The behavior-based criteria, such as how recently users have used your app, for the segment.
Recency (dict) --
The dimension settings that are based on how recently an endpoint was active.
Duration (string) --
The duration to use when determining whether an endpoint is active or inactive.
RecencyType (string) --
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
Demographic (dict) --
The demographic-based criteria, such as device platform, for the segment.
AppVersion (dict) --
The app version criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Channel (dict) --
The channel criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
DeviceType (dict) --
The device type criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Make (dict) --
The device make criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Model (dict) --
The device model criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Platform (dict) --
The device platform criteria for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Location (dict) --
The location-based criteria, such as region or GPS coordinates, for the segment.
Country (dict) --
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
DimensionType (string) --
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
GPSPoint (dict) --
The GPS location and range for the segment.
Coordinates (dict) --
The GPS coordinates to measure distance from.
Latitude (float) --
The latitude coordinate of the location.
Longitude (float) --
The longitude coordinate of the location.
RangeInKilometers (float) --
The range, in kilometers, from the GPS coordinates.
Metrics (dict) --
One or more custom metrics to use as criteria for the segment.
(string) --
(dict) --
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
ComparisonOperator (string) --
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
Value (float) --
The value to compare.
UserAttributes (dict) --
One or more custom user attributes to use as criteria for the segment.
(string) --
(dict) --
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType (string) --
The type of segment dimension to use. Valid values are:
Values (list) --
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
SourceSegments (list) --
The base segment to build the segment on. A base segment, also referred to as a source segment , defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
(dict) --
Specifies the segment identifier and version of a segment.
Id (string) --
The unique identifier for the segment.
Version (integer) --
The version number of the segment.
SourceType (string) --
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
Type (string) --
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
Include (string) --
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
SegmentType (string) --
The segment type. Valid values are:
tags (dict) --
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
Version (integer) --
The version number of the segment.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_sms_channel(**kwargs)¶Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_sms_channel(
ApplicationId='string',
SMSChannelRequest={
'Enabled': True|False,
'SenderId': 'string',
'ShortCode': 'string'
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the status and settings of the SMS channel for an application.
Specifies whether to enable the SMS channel for the application.
The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
The registered short code that you want to use when you send messages through the SMS channel.
dict
Response Syntax
{
'SMSChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'PromotionalMessagesPerSecond': 123,
'SenderId': 'string',
'ShortCode': 'string',
'TransactionalMessagesPerSecond': 123,
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
SMSChannelResponse (dict) --
Provides information about the status and settings of the SMS channel for an application.
ApplicationId (string) --
The unique identifier for the application that the SMS channel applies to.
CreationDate (string) --
The date and time, in ISO 8601 format, when the SMS channel was enabled.
Enabled (boolean) --
Specifies whether the SMS channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
Id (string) --
(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the SMS channel is archived.
LastModifiedBy (string) --
The user who last modified the SMS channel.
LastModifiedDate (string) --
The date and time, in ISO 8601 format, when the SMS channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
PromotionalMessagesPerSecond (integer) --
The maximum number of promotional messages that you can send through the SMS channel each second.
SenderId (string) --
The identity that displays on recipients' devices when they receive messages from the SMS channel.
ShortCode (string) --
The registered short code to use when you send messages through the SMS channel.
TransactionalMessagesPerSecond (integer) --
The maximum number of transactional messages that you can send through the SMS channel each second.
Version (integer) --
The current version of the SMS channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_sms_template(**kwargs)¶Updates an existing message template for messages that are sent through the SMS channel.
See also: AWS API Documentation
Request Syntax
response = client.update_sms_template(
CreateNewVersion=True|False,
SMSTemplateRequest={
'Body': 'string',
'DefaultSubstitutions': 'string',
'RecommenderId': 'string',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string'
},
TemplateName='string',
Version='string'
)
Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
[REQUIRED]
Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
The message body to use in text messages that are based on the message template.
A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
A custom description of the message template.
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_template_active_version(**kwargs)¶Changes the status of a specific version of a message template to active .
See also: AWS API Documentation
Request Syntax
response = client.update_template_active_version(
TemplateActiveVersionRequest={
'Version': 'string'
},
TemplateName='string',
TemplateType='string'
)
[REQUIRED]
Specifies which version of a message template to use as the active version of the template.
The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource.
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
[REQUIRED]
The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request succeeded.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_voice_channel(**kwargs)¶Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
See also: AWS API Documentation
Request Syntax
response = client.update_voice_channel(
ApplicationId='string',
VoiceChannelRequest={
'Enabled': True|False
}
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[REQUIRED]
Specifies the status and settings of the voice channel for an application.
Specifies whether to enable the voice channel for the application.
dict
Response Syntax
{
'VoiceChannelResponse': {
'ApplicationId': 'string',
'CreationDate': 'string',
'Enabled': True|False,
'HasCredential': True|False,
'Id': 'string',
'IsArchived': True|False,
'LastModifiedBy': 'string',
'LastModifiedDate': 'string',
'Platform': 'string',
'Version': 123
}
}
Response Structure
(dict) --
The request succeeded.
VoiceChannelResponse (dict) --
Provides information about the status and settings of the voice channel for an application.
ApplicationId (string) --
The unique identifier for the application that the voice channel applies to.
CreationDate (string) --
The date and time, in ISO 8601 format, when the voice channel was enabled.
Enabled (boolean) --
Specifies whether the voice channel is enabled for the application.
HasCredential (boolean) --
(Not used) This property is retained only for backward compatibility.
Id (string) --
(Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
IsArchived (boolean) --
Specifies whether the voice channel is archived.
LastModifiedBy (string) --
The user who last modified the voice channel.
LastModifiedDate (string) --
The date and time, in ISO 8601 format, when the voice channel was last modified.
Platform (string) --
The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.
Version (integer) --
The current version of the voice channel.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionupdate_voice_template(**kwargs)¶Updates an existing message template for messages that are sent through the voice channel.
See also: AWS API Documentation
Request Syntax
response = client.update_voice_template(
CreateNewVersion=True|False,
TemplateName='string',
Version='string',
VoiceTemplateRequest={
'Body': 'string',
'DefaultSubstitutions': 'string',
'LanguageCode': 'string',
'tags': {
'string': 'string'
},
'TemplateDescription': 'string',
'VoiceId': 'string'
}
)
Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
[REQUIRED]
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
[REQUIRED]
Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.
The text of the script to use in messages that are based on the message template, in plain text format.
A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide .
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
A custom description of the message template.
The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide .
dict
Response Syntax
{
'MessageBody': {
'Message': 'string',
'RequestID': 'string'
}
}
Response Structure
(dict) --
The request was accepted for processing. Processing may not be complete.
MessageBody (dict) --
Provides information about an API request or response.
Message (string) --
The message that's returned from the API.
RequestID (string) --
The unique identifier for the request or response.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsExceptionverify_otp_message(**kwargs)¶Verify an OTP
See also: AWS API Documentation
Request Syntax
response = client.verify_otp_message(
ApplicationId='string',
VerifyOTPMessageRequestParameters={
'DestinationIdentity': 'string',
'Otp': 'string',
'ReferenceId': 'string'
}
)
[REQUIRED]
The unique ID of your Amazon Pinpoint application.
[REQUIRED]
Verify OTP message request.
The destination identity to send OTP to.
The OTP the end user provided for verification.
The reference identifier provided when the OTP was previously sent.
dict
Response Syntax
{
'VerificationResponse': {
'Valid': True|False
}
}
Response Structure
(dict) --
200 response
VerificationResponse (dict) --
Verify OTP Message Response.
Valid (boolean) --
Specifies whether the OTP is valid or not.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsException