Module aws_sdk_pinpoint::model [−][src]
Expand description
Data structures used by operation inputs/outputs.
Modules
Structs
Provides information about the activities that were performed by a campaign.
Specifies the configuration and other settings for an activity in a journey.
Provides information about an activity that was performed by a campaign.
Specifies address-based configuration settings for a message that's sent directly to an endpoint.
Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.
Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
Specifies the settings for a one-time message that's sent directly to an endpoint through the ADM (Amazon Device Messaging) channel.
Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.
Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.
Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
Specifies the settings for a one-time message that's sent directly to an endpoint through the APNs (Apple Push Notification service) channel.
Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) channel.
Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
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.
Provides information about an application.
Provides information about an application, including the default settings for an application.
Provides information about all of your applications.
Specifies attribute-based criteria for including or excluding endpoints from a segment.
Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.
Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
Specifies the settings for a one-time message that's sent directly to an endpoint through the Baidu (Baidu Cloud Push) channel.
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.
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.
Specifies the content and "From" address for an email message that's sent to recipients of a campaign.
Specifies the settings for events that cause a campaign to be sent.
Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.
In-app message configuration.
For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns in the application can send.
Provides information about the status, configuration, and other settings for a campaign.
Specifies the content and settings for an SMS message that's sent to recipients of a campaign.
Provides information about the status of a campaign.
Provides information about the configuration and other settings for all the campaigns that are associated with an application.
Provides information about the general settings and status of a channel for an application.
Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.
Specifies the conditions to evaluate for an activity in a journey, and how to evaluate those conditions.
Specifies the settings for a yes/no split activity in a journey. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
To create yes/no split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.
Specifies the display name of an application and the tags to associate with the application.
Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
Provides information about a request to create a message template.
Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. This object is required if you use the CampaignCustomMessage object to define the message to send for the campaign or campaign treatment.
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
Default button configuration.
Specifies the default message for all channels.
Specifies the default settings and content for a push notification that's sent directly to an endpoint.
Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.
Specifies the settings and content for the default message and any default messages that you tailored for specific channels.
Specifies the status and settings of the email channel for an application.
Provides information about the status and settings of the email channel for an application.
Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.
Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants.
Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.
Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.
Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.
Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.
Specifies demographic information about an endpoint, such as the applicable time zone and platform.
Provides the status code and message that result from processing data for an endpoint.
Specifies geographic information about an endpoint.
Provides information about the delivery status and results of sending a message directly to an endpoint.
Specifies the channel type and other settings for an endpoint.
Provides information about the channel type and other settings for an endpoint.
Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.
Specifies data for one or more attributes that describe the user who's associated with an endpoint.
Provides information about all the endpoints that are associated with a user ID.
Specifies information about an event that reports data to Amazon Pinpoint.
Specifies the conditions to evaluate for an event that applies to an activity in a journey.
Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Provides the status code and message that result from processing an event.
Specifies the settings for an event that causes a journey activity to start.
Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.
Specifies a batch of endpoints and events to process.
Specifies a batch of events to process.
Provides information about endpoints and the events that they're associated with.
Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.
Provides information about the resource settings for 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.
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.
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.
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.
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.
Specifies the settings for a one-time message that's sent directly to an endpoint through the GCM channel. The GCM channel enables Amazon Pinpoint to send messages to the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
Specifies the GPS coordinates of a location.
Specifies GPS-based criteria for including or excluding endpoints from a segment.
Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.
Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.
Provides information about the resource settings for 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.
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.
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.
Schedule of the campaign.
Provides all fields required for building an in-app message.
Text config for Message Body.
Button Config for an in-app message.
Targeted in-app message campaign.
The configuration for the message content.
Text config for Message Header.
Get in-app messages response object.
InApp Template Request.
In-App Template Response.
Provides information about the results of a request to create or update an endpoint that's associated with an event.
The channel-specific configurations for the journey.
Specifies the message content for a custom channel message that's sent to participants in a journey.
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.
Specifies the "From" address for an email message that's sent to participants in a journey.
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.
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.
Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.
Specifies the message configuration for a push notification that's sent to participants in a journey.
Provides information about the status, configuration, and other settings for a journey.
Specifies the schedule settings for a journey.
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
Changes the status of a journey.
Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.
Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
Specifies the content and settings for a push notification that's sent to recipients of a campaign.
Provides information about an API request or response.
Specifies the message configuration settings for a campaign.
Specifies the configuration and other settings for a message.
Provides information about the results of a request to send a message to an endpoint address.
Provides information about the results of sending a message directly to an endpoint address.
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
Specifies a condition to evaluate for an activity path in a journey.
Specifies the settings for a multivariate split activity in a journey. 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.
To create multivariate split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.
Specifies a phone number to validate and retrieve information about.
Provides information about a phone number.
Override button configuration.
Specifies the properties and attributes of an endpoint that's associated with an event.
Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants.
Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.
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.
Specifies the start and end times that define a time range when messages aren't sent to endpoints.
Specifies the settings for a random split activity in a journey. 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.
Specifies the settings for a path in a random split activity in a journey.
Specifies the contents of an email message, represented as a raw MIME message.
Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.
Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
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.
Specifies the schedule settings for a campaign.
Specifies dimension settings for including or excluding endpoints from a segment based on how recently an endpoint was active.
Specifies a segment to associate with an activity in a journey.
Specifies demographic-based dimension settings for including or excluding endpoints from a segment. These settings derive from characteristics of endpoint devices, such as platform, make, and model.
Specifies the dimension settings for a segment.
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
Specifies the settings that define the relationships between segment groups for a segment.
Provides information about the import job that created a segment. An import job is a job that creates a user segment by importing endpoint definitions.
Specifies geographical dimension settings for a segment.
Specifies the segment identifier and version of a segment.
Provides information about the configuration, dimension, and other settings for a segment.
Provides information about all the segments that are associated with an application.
Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.
Provides information about which users and endpoints a message was sent to.
Provides information about a session.
Specifies the dimension type and values for a segment dimension.
Specifies a condition to evaluate for an activity in a journey.
Specifies the contents of an email message, composed of a subject, a text part, and an HTML part.
Specifies the subject or body of an email message, represented as textual email data and the applicable character set.
Specifies the status and settings of the SMS channel for an application.
Provides information about the status and settings of the SMS channel for an application.
Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.
Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.
Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
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.
Specifies the conditions for the first activity in a journey. This activity and its conditions determine which users are participants in a journey.
Specifies the tags (keys and values) for an application, campaign, message template, or segment.
Specifies the name and version of the message template to use for the message.
Specifies which version of a message template to use as the active version of the template.
Specifies the message template to use for the message, for each type of channel.
Provides information about a request to create a message template.
Provides information about a message template that's associated with your Amazon Pinpoint account.
Provides information about a specific version of a message template.
Provides information about all the versions of a specific message template.
Provides information about all the message templates that are associated with your Amazon Pinpoint account.
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.
Specifies one or more attributes to remove from all the endpoints that are associated with an application.
Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
Specifies the status and settings of the voice channel for an application.
Provides information about the status and settings of the voice channel for an application.
Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.
Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.
Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.
Specifies the settings for a wait activity in a journey. 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.
Specifies a duration or a date and time that indicates when Amazon Pinpoint determines whether an activity's conditions have been met or an activity moves participants to the next activity in a journey.
Specifies the default settings for an application.
Specifies the configuration and other settings for a campaign.
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.
Specifies the configuration and other settings for a journey.
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.
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.