AWS SDK for PHP 3.x

Service ID: pinpoint

Version: 2016-12-01

This page describes the parameters and results for the operations of the Amazon Pinpoint (2016-12-01), and shows how to use the Aws\Pinpoint\PinpointClient object to call the described operations. This documentation is specific to the 2016-12-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateApp ( array $params = [] ): Creates an application.
CreateCampaign ( array $params = [] ): Creates a new campaign for an application or updates the settings of an existing campaign for an application.
CreateEmailTemplate ( array $params = [] ): Creates a message template for messages that are sent through the email channel.
CreateExportJob ( array $params = [] ): Creates an export job for an application.
CreateImportJob ( array $params = [] ): Creates an import job for an application.
CreateInAppTemplate ( array $params = [] ): Creates a new message template for messages using the in-app message channel.
CreateJourney ( array $params = [] ): Creates a journey for an application.
CreatePushTemplate ( array $params = [] ): Creates a message template for messages that are sent through a push notification channel.
CreateRecommenderConfiguration ( array $params = [] ): Creates an Amazon Pinpoint configuration for a recommender model.
CreateSegment ( array $params = [] ): 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.
CreateSmsTemplate ( array $params = [] ): Creates a message template for messages that are sent through the SMS channel.
CreateVoiceTemplate ( array $params = [] ): Creates a message template for messages that are sent through the voice channel.
DeleteAdmChannel ( array $params = [] ): Disables the ADM channel for an application and deletes any existing settings for the channel.
DeleteApnsChannel ( array $params = [] ): Disables the APNs channel for an application and deletes any existing settings for the channel.
DeleteApnsSandboxChannel ( array $params = [] ): Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
DeleteApnsVoipChannel ( array $params = [] ): Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
DeleteApnsVoipSandboxChannel ( array $params = [] ): Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
DeleteApp ( array $params = [] ): Deletes an application.
DeleteBaiduChannel ( array $params = [] ): Disables the Baidu channel for an application and deletes any existing settings for the channel.
DeleteCampaign ( array $params = [] ): Deletes a campaign from an application.
DeleteEmailChannel ( array $params = [] ): Disables the email channel for an application and deletes any existing settings for the channel.
DeleteEmailTemplate ( array $params = [] ): Deletes a message template for messages that were sent through the email channel.
DeleteEndpoint ( array $params = [] ): Deletes an endpoint from an application.
DeleteEventStream ( array $params = [] ): Deletes the event stream for an application.
DeleteGcmChannel ( array $params = [] ): Disables the GCM channel for an application and deletes any existing settings for the channel.
DeleteInAppTemplate ( array $params = [] ): Deletes a message template for messages sent using the in-app message channel.
DeleteJourney ( array $params = [] ): Deletes a journey from an application.
DeletePushTemplate ( array $params = [] ): Deletes a message template for messages that were sent through a push notification channel.
DeleteRecommenderConfiguration ( array $params = [] ): Deletes an Amazon Pinpoint configuration for a recommender model.
DeleteSegment ( array $params = [] ): Deletes a segment from an application.
DeleteSmsChannel ( array $params = [] ): Disables the SMS channel for an application and deletes any existing settings for the channel.
DeleteSmsTemplate ( array $params = [] ): Deletes a message template for messages that were sent through the SMS channel.
DeleteUserEndpoints ( array $params = [] ): Deletes all the endpoints that are associated with a specific user ID.
DeleteVoiceChannel ( array $params = [] ): Disables the voice channel for an application and deletes any existing settings for the channel.
DeleteVoiceTemplate ( array $params = [] ): Deletes a message template for messages that were sent through the voice channel.
GetAdmChannel ( array $params = [] ): Retrieves information about the status and settings of the ADM channel for an application.
GetApnsChannel ( array $params = [] ): Retrieves information about the status and settings of the APNs channel for an application.
GetApnsSandboxChannel ( array $params = [] ): Retrieves information about the status and settings of the APNs sandbox channel for an application.
GetApnsVoipChannel ( array $params = [] ): Retrieves information about the status and settings of the APNs VoIP channel for an application.
GetApnsVoipSandboxChannel ( array $params = [] ): Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
GetApp ( array $params = [] ): Retrieves information about an application.
GetApplicationDateRangeKpi ( array $params = [] ): Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
GetApplicationSettings ( array $params = [] ): Retrieves information about the settings for an application.
GetApps ( array $params = [] ): Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
GetBaiduChannel ( array $params = [] ): Retrieves information about the status and settings of the Baidu channel for an application.
GetCampaign ( array $params = [] ): Retrieves information about the status, configuration, and other settings for a campaign.
GetCampaignActivities ( array $params = [] ): Retrieves information about all the activities for a campaign.
GetCampaignDateRangeKpi ( array $params = [] ): Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
GetCampaignVersion ( array $params = [] ): Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
GetCampaignVersions ( array $params = [] ): Retrieves information about the status, configuration, and other settings for all versions of a campaign.
GetCampaigns ( array $params = [] ): Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
GetChannels ( array $params = [] ): Retrieves information about the history and status of each channel for an application.
GetEmailChannel ( array $params = [] ): Retrieves information about the status and settings of the email channel for an application.
GetEmailTemplate ( array $params = [] ): Retrieves the content and settings of a message template for messages that are sent through the email channel.
GetEventStream ( array $params = [] ): Retrieves information about the event stream settings for an application.
GetExportJob ( array $params = [] ): Retrieves information about the status and settings of a specific export job for an application.
GetExportJobs ( array $params = [] ): Retrieves information about the status and settings of all the export jobs for an application.
GetGcmChannel ( array $params = [] ): Retrieves information about the status and settings of the GCM channel for an application.
GetImportJob ( array $params = [] ): Retrieves information about the status and settings of a specific import job for an application.
GetImportJobs ( array $params = [] ): Retrieves information about the status and settings of all the import jobs for an application.
GetInAppMessages ( array $params = [] ): Retrieves the in-app messages targeted for the provided endpoint ID.
GetInAppTemplate ( array $params = [] ): Retrieves the content and settings of a message template for messages sent through the in-app channel.
GetJourney ( array $params = [] ): Retrieves information about the status, configuration, and other settings for a journey.
GetJourneyDateRangeKpi ( array $params = [] ): Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
GetJourneyExecutionActivityMetrics ( array $params = [] ): Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
GetJourneyExecutionMetrics ( array $params = [] ): Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
GetJourneyRunExecutionActivityMetrics ( array $params = [] ): Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.
GetJourneyRunExecutionMetrics ( array $params = [] ): Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.
GetJourneyRuns ( array $params = [] ): Provides information about the runs of a journey.
GetPushTemplate ( array $params = [] ): Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
GetRecommenderConfiguration ( array $params = [] ): Retrieves information about an Amazon Pinpoint configuration for a recommender model.
GetRecommenderConfigurations ( array $params = [] ): Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
GetSegment ( array $params = [] ): Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
GetSegmentExportJobs ( array $params = [] ): Retrieves information about the status and settings of the export jobs for a segment.
GetSegmentImportJobs ( array $params = [] ): Retrieves information about the status and settings of the import jobs for a segment.
GetSegmentVersion ( array $params = [] ): Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
GetSegmentVersions ( array $params = [] ): Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.
GetSegments ( array $params = [] ): Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
GetSmsChannel ( array $params = [] ): Retrieves information about the status and settings of the SMS channel for an application.
GetSmsTemplate ( array $params = [] ): Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
GetUserEndpoint ( array $params = [] ): Retrieves information about the settings and attributes of a specific endpoint for an application.
GetUserEndpoints ( array $params = [] ): Retrieves information about all the endpoints that are associated with a specific user ID.
GetVoiceChannel ( array $params = [] ): Retrieves information about the status and settings of the voice channel for an application.
GetVoiceTemplate ( array $params = [] ): Retrieves the content and settings of a message template for messages that are sent through the voice channel.
ListJourneys ( array $params = [] ): Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
ListTagsForResource ( array $params = [] ): Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
ListTemplateVersions ( array $params = [] ): Retrieves information about all the versions of a specific message template.
ListTemplates ( array $params = [] ): Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
PhoneNumberValidate ( array $params = [] ): Retrieves information about a phone number.
PutEventStream ( array $params = [] ): Creates a new event stream for an application or updates the settings of an existing event stream for an application.
PutEvents ( array $params = [] ): Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
RemoveAttributes ( array $params = [] ): Removes one or more custom attributes, of the same attribute type, from the application.
SendMessages ( array $params = [] ): Creates and sends a direct message.
SendOTPMessage ( array $params = [] ): Send an OTP message
SendUsersMessages ( array $params = [] ): Creates and sends a message to a list of users.
TagResource ( array $params = [] ): Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
UntagResource ( array $params = [] ): Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
UpdateAdmChannel ( array $params = [] ): Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
UpdateApnsChannel ( array $params = [] ): Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
UpdateApnsSandboxChannel ( array $params = [] ): Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
UpdateApnsVoipChannel ( array $params = [] ): Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
UpdateApnsVoipSandboxChannel ( array $params = [] ): Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
UpdateApplicationSettings ( array $params = [] ): Updates the settings for an application.
UpdateBaiduChannel ( array $params = [] ): Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
UpdateCampaign ( array $params = [] ): Updates the configuration and other settings for a campaign.
UpdateEmailChannel ( array $params = [] ): Enables the email channel for an application or updates the status and settings of the email channel for an application.
UpdateEmailTemplate ( array $params = [] ): Updates an existing message template for messages that are sent through the email channel.
UpdateGcmChannel ( array $params = [] ): Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
UpdateInAppTemplate ( array $params = [] ): Updates an existing message template for messages sent through the in-app message channel.
UpdateJourney ( array $params = [] ): Updates the configuration and other settings for a journey.
UpdateJourneyState ( array $params = [] ): Pause, resume or cancels (stops) a journey.
UpdatePushTemplate ( array $params = [] ): Updates an existing message template for messages that are sent through a push notification channel.
UpdateRecommenderConfiguration ( array $params = [] ): Updates an Amazon Pinpoint configuration for a recommender model.
UpdateSegment ( array $params = [] ): 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.
UpdateSmsChannel ( array $params = [] ): Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
UpdateSmsTemplate ( array $params = [] ): Updates an existing message template for messages that are sent through the SMS channel.
UpdateTemplateActiveVersion ( array $params = [] ): Changes the status of a specific version of a message template to active.
UpdateUserEndpoint ( array $params = [] ): Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application.
UpdateUserEndpointsBatch ( array $params = [] ): Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application.
UpdateVoiceChannel ( array $params = [] ): Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
UpdateVoiceTemplate ( array $params = [] ): Updates an existing message template for messages that are sent through the voice channel.
VerifyOTPMessage ( array $params = [] ): Verify an OTP

Operations

CreateApp

$result = $client->createApp([/* ... */]);
$promise = $client->createAppAsync([/* ... */]);

Creates an application.

Parameter Syntax

$result = $client->createApp([
    'CreateApplicationRequest' => [ // REQUIRED
        'Name' => '<string>', // REQUIRED
        'tags' => ['<string>', ...],
    ],
]);

Parameter Details

Members

CreateApplicationRequest

: Required: Yes
: Type: CreateApplicationRequest structure

Specifies the display name of an application and the tags to associate with the application.

Result Syntax

[
    'ApplicationResponse' => [
        'Arn' => '<string>',
        'CreationDate' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

ApplicationResponse

: Required: Yes
: Type: ApplicationResponse structure

Provides information about an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

CreateCampaign

$result = $client->createCampaign([/* ... */]);
$promise = $client->createCampaignAsync([/* ... */]);

Creates a new campaign for an application or updates the settings of an existing campaign for an application.

Parameter Syntax

$result = $client->createCampaign([
    'ApplicationId' => '<string>', // REQUIRED
    'WriteCampaignRequest' => [ // REQUIRED
        'AdditionalTreatments' => [
            [
                'CustomDeliveryConfiguration' => [
                    'DeliveryUri' => '<string>', // REQUIRED
                    'EndpointTypes' => ['<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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<string>',
                    ],
                    'EmailMessage' => [
                        'Body' => '<string>',
                        'FromAddress' => '<string>',
                        'Headers' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<string>',
                    ],
                    'InAppMessage' => [
                        'Body' => '<string>',
                        'Content' => [
                            [
                                'BackgroundColor' => '<string>',
                                'BodyConfig' => [
                                    'Alignment' => 'LEFT|CENTER|RIGHT', // REQUIRED
                                    'Body' => '<string>', // REQUIRED
                                    'TextColor' => '<string>', // REQUIRED
                                ],
                                'HeaderConfig' => [
                                    'Alignment' => 'LEFT|CENTER|RIGHT', // REQUIRED
                                    'Header' => '<string>', // REQUIRED
                                    'TextColor' => '<string>', // REQUIRED
                                ],
                                'ImageUrl' => '<string>',
                                'PrimaryBtn' => [
                                    'Android' => [
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                    ],
                                    'DefaultConfig' => [
                                        'BackgroundColor' => '<string>',
                                        'BorderRadius' => <integer>,
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                        'Text' => '<string>', // REQUIRED
                                        'TextColor' => '<string>',
                                    ],
                                    'IOS' => [
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                    ],
                                    'Web' => [
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                    ],
                                ],
                                'SecondaryBtn' => [
                                    'Android' => [
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                    ],
                                    'DefaultConfig' => [
                                        'BackgroundColor' => '<string>',
                                        'BorderRadius' => <integer>,
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                        'Text' => '<string>', // REQUIRED
                                        'TextColor' => '<string>',
                                    ],
                                    'IOS' => [
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                    ],
                                    'Web' => [
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                    ],
                                ],
                            ],
                            // ...
                        ],
                        'CustomConfig' => ['<string>', ...],
                        'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
                    ],
                    'SMSMessage' => [
                        'Body' => '<string>',
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                ],
                'Schedule' => [
                    'EndTime' => '<string>',
                    'EventFilter' => [
                        'Dimensions' => [ // REQUIRED
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                // ...
                            ],
                            'EventType' => [
                                'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                'Values' => ['<string>', ...], // REQUIRED
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>', // REQUIRED
                                    'Value' => <float>, // REQUIRED
                                ],
                                // ...
                            ],
                        ],
                        'FilterType' => 'SYSTEM|ENDPOINT', // REQUIRED
                    ],
                    'Frequency' => 'ONCE|HOURLY|DAILY|WEEKLY|MONTHLY|EVENT|IN_APP_EVENT',
                    'IsLocalTime' => true || false,
                    'QuietTime' => [
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    'StartTime' => '<string>', // REQUIRED
                    'Timezone' => '<string>',
                ],
                'SizePercent' => <integer>, // REQUIRED
                'TemplateConfiguration' => [
                    'EmailTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                    'InAppTemplate' => [
                        '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>', // REQUIRED
            'EndpointTypes' => ['<string>', ...],
        ],
        'Description' => '<string>',
        'HoldoutPercent' => <integer>,
        'Hook' => [
            'LambdaFunctionName' => '<string>',
            'Mode' => 'DELIVERY|FILTER',
            'WebUrl' => '<string>',
        ],
        'IsPaused' => true || false,
        'Limits' => [
            'Daily' => <integer>,
            'MaximumDuration' => <integer>,
            'MessagesPerSecond' => <integer>,
            'Session' => <integer>,
            'Total' => <integer>,
        ],
        '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' => <integer>,
                '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' => <integer>,
                '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' => <integer>,
                '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' => <integer>,
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'EmailMessage' => [
                'Body' => '<string>',
                'FromAddress' => '<string>',
                'Headers' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<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' => <integer>,
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'InAppMessage' => [
                'Body' => '<string>',
                'Content' => [
                    [
                        'BackgroundColor' => '<string>',
                        'BodyConfig' => [
                            'Alignment' => 'LEFT|CENTER|RIGHT', // REQUIRED
                            'Body' => '<string>', // REQUIRED
                            'TextColor' => '<string>', // REQUIRED
                        ],
                        'HeaderConfig' => [
                            'Alignment' => 'LEFT|CENTER|RIGHT', // REQUIRED
                            'Header' => '<string>', // REQUIRED
                            'TextColor' => '<string>', // REQUIRED
                        ],
                        'ImageUrl' => '<string>',
                        'PrimaryBtn' => [
                            'Android' => [
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                            ],
                            'DefaultConfig' => [
                                'BackgroundColor' => '<string>',
                                'BorderRadius' => <integer>,
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                                'Text' => '<string>', // REQUIRED
                                'TextColor' => '<string>',
                            ],
                            'IOS' => [
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                            ],
                            'Web' => [
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                            ],
                        ],
                        'SecondaryBtn' => [
                            'Android' => [
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                            ],
                            'DefaultConfig' => [
                                'BackgroundColor' => '<string>',
                                'BorderRadius' => <integer>,
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                                'Text' => '<string>', // REQUIRED
                                'TextColor' => '<string>',
                            ],
                            'IOS' => [
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                            ],
                            'Web' => [
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
                'CustomConfig' => ['<string>', ...],
                'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
            ],
            'SMSMessage' => [
                'Body' => '<string>',
                'EntityId' => '<string>',
                'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                'OriginationNumber' => '<string>',
                'SenderId' => '<string>',
                'TemplateId' => '<string>',
            ],
        ],
        'Name' => '<string>',
        'Priority' => <integer>,
        'Schedule' => [
            'EndTime' => '<string>',
            'EventFilter' => [
                'Dimensions' => [ // REQUIRED
                    'Attributes' => [
                        '<__string>' => [
                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                            'Values' => ['<string>', ...], // REQUIRED
                        ],
                        // ...
                    ],
                    'EventType' => [
                        'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                        'Values' => ['<string>', ...], // REQUIRED
                    ],
                    'Metrics' => [
                        '<__string>' => [
                            'ComparisonOperator' => '<string>', // REQUIRED
                            'Value' => <float>, // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'FilterType' => 'SYSTEM|ENDPOINT', // REQUIRED
            ],
            'Frequency' => 'ONCE|HOURLY|DAILY|WEEKLY|MONTHLY|EVENT|IN_APP_EVENT',
            'IsLocalTime' => true || false,
            'QuietTime' => [
                'End' => '<string>',
                'Start' => '<string>',
            ],
            'StartTime' => '<string>', // REQUIRED
            'Timezone' => '<string>',
        ],
        'SegmentId' => '<string>',
        'SegmentVersion' => <integer>,
        'TemplateConfiguration' => [
            'EmailTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'InAppTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'PushTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'SMSTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'VoiceTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
        ],
        'TreatmentDescription' => '<string>',
        'TreatmentName' => '<string>',
        'tags' => ['<string>', ...],
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

WriteCampaignRequest

: Required: Yes
: Type: WriteCampaignRequest structure

Specifies the configuration and other settings for a campaign.

Result Syntax

[
    'CampaignResponse' => [
        'AdditionalTreatments' => [
            [
                'CustomDeliveryConfiguration' => [
                    'DeliveryUri' => '<string>',
                    'EndpointTypes' => ['<string>', ...],
                ],
                '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<string>',
                    ],
                    'EmailMessage' => [
                        'Body' => '<string>',
                        'FromAddress' => '<string>',
                        'Headers' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<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' => <integer>,
                                        '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' => <integer>,
                                        '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>', ...],
                        'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
                    ],
                    'SMSMessage' => [
                        'Body' => '<string>',
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                ],
                'Schedule' => [
                    'EndTime' => '<string>',
                    'EventFilter' => [
                        'Dimensions' => [
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'EventType' => [
                                'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                'Values' => ['<string>', ...],
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>',
                                    'Value' => <float>,
                                ],
                                // ...
                            ],
                        ],
                        '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' => <integer>,
                'State' => [
                    'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
                ],
                'TemplateConfiguration' => [
                    'EmailTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                    'InAppTemplate' => [
                        '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' => ['<string>', ...],
        ],
        'DefaultState' => [
            'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
        ],
        'Description' => '<string>',
        'HoldoutPercent' => <integer>,
        'Hook' => [
            'LambdaFunctionName' => '<string>',
            'Mode' => 'DELIVERY|FILTER',
            'WebUrl' => '<string>',
        ],
        'Id' => '<string>',
        'IsPaused' => true || false,
        'LastModifiedDate' => '<string>',
        'Limits' => [
            'Daily' => <integer>,
            'MaximumDuration' => <integer>,
            'MessagesPerSecond' => <integer>,
            'Session' => <integer>,
            'Total' => <integer>,
        ],
        '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' => <integer>,
                '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' => <integer>,
                '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' => <integer>,
                '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' => <integer>,
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'EmailMessage' => [
                'Body' => '<string>',
                'FromAddress' => '<string>',
                'Headers' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<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' => <integer>,
                'Title' => '<string>',
                'Url' => '<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' => <integer>,
                                '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' => <integer>,
                                '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>', ...],
                'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
            ],
            'SMSMessage' => [
                'Body' => '<string>',
                'EntityId' => '<string>',
                'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                'OriginationNumber' => '<string>',
                'SenderId' => '<string>',
                'TemplateId' => '<string>',
            ],
        ],
        'Name' => '<string>',
        'Priority' => <integer>,
        'Schedule' => [
            'EndTime' => '<string>',
            'EventFilter' => [
                'Dimensions' => [
                    'Attributes' => [
                        '<__string>' => [
                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                            'Values' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'EventType' => [
                        'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                        'Values' => ['<string>', ...],
                    ],
                    'Metrics' => [
                        '<__string>' => [
                            'ComparisonOperator' => '<string>',
                            'Value' => <float>,
                        ],
                        // ...
                    ],
                ],
                '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' => <integer>,
        'State' => [
            'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
        ],
        'TemplateConfiguration' => [
            'EmailTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'InAppTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'PushTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'SMSTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'VoiceTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
        ],
        'TreatmentDescription' => '<string>',
        'TreatmentName' => '<string>',
        'Version' => <integer>,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

CampaignResponse

: Required: Yes
: Type: CampaignResponse structure

Provides information about the status, configuration, and other settings for a campaign.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

CreateEmailTemplate

$result = $client->createEmailTemplate([/* ... */]);
$promise = $client->createEmailTemplateAsync([/* ... */]);

Creates a message template for messages that are sent through the email channel.

Parameter Syntax

$result = $client->createEmailTemplate([
    'EmailTemplateRequest' => [ // REQUIRED
        'DefaultSubstitutions' => '<string>',
        'Headers' => [
            [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'HtmlPart' => '<string>',
        'RecommenderId' => '<string>',
        'Subject' => '<string>',
        'TemplateDescription' => '<string>',
        'TextPart' => '<string>',
        'tags' => ['<string>', ...],
    ],
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members

EmailTemplateRequest

: Required: Yes
: Type: EmailTemplateRequest structure

Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.

TemplateName

: Required: Yes
: Type: string

Result Syntax

[
    'CreateTemplateMessageBody' => [
        'Arn' => '<string>',
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

CreateTemplateMessageBody

: Required: Yes
: Type: CreateTemplateMessageBody structure

Provides information about a request to create a message template.

Errors

MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.
BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.

CreateExportJob

$result = $client->createExportJob([/* ... */]);
$promise = $client->createExportJobAsync([/* ... */]);

Creates an export job for an application.

Parameter Syntax

$result = $client->createExportJob([
    'ApplicationId' => '<string>', // REQUIRED
    'ExportJobRequest' => [ // REQUIRED
        'RoleArn' => '<string>', // REQUIRED
        'S3UrlPrefix' => '<string>', // REQUIRED
        'SegmentId' => '<string>',
        'SegmentVersion' => <integer>,
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

ExportJobRequest

: Required: Yes
: Type: ExportJobRequest structure

Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.

Result Syntax

[
    'ExportJobResponse' => [
        'ApplicationId' => '<string>',
        'CompletedPieces' => <integer>,
        'CompletionDate' => '<string>',
        'CreationDate' => '<string>',
        'Definition' => [
            'RoleArn' => '<string>',
            'S3UrlPrefix' => '<string>',
            'SegmentId' => '<string>',
            'SegmentVersion' => <integer>,
        ],
        'FailedPieces' => <integer>,
        'Failures' => ['<string>', ...],
        'Id' => '<string>',
        'JobStatus' => 'CREATED|PREPARING_FOR_INITIALIZATION|INITIALIZING|PROCESSING|PENDING_JOB|COMPLETING|COMPLETED|FAILING|FAILED',
        'TotalFailures' => <integer>,
        'TotalPieces' => <integer>,
        'TotalProcessed' => <integer>,
        'Type' => '<string>',
    ],
]

Result Details

Members

ExportJobResponse

: Required: Yes
: Type: ExportJobResponse structure

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.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

CreateImportJob

$result = $client->createImportJob([/* ... */]);
$promise = $client->createImportJobAsync([/* ... */]);

Creates an import job for an application.

Parameter Syntax

$result = $client->createImportJob([
    'ApplicationId' => '<string>', // REQUIRED
    'ImportJobRequest' => [ // REQUIRED
        'DefineSegment' => true || false,
        'ExternalId' => '<string>',
        'Format' => 'CSV|JSON', // REQUIRED
        'RegisterEndpoints' => true || false,
        'RoleArn' => '<string>', // REQUIRED
        'S3Url' => '<string>', // REQUIRED
        'SegmentId' => '<string>',
        'SegmentName' => '<string>',
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

ImportJobRequest

: Required: Yes
: Type: ImportJobRequest structure

Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.

Result Syntax

[
    'ImportJobResponse' => [
        'ApplicationId' => '<string>',
        'CompletedPieces' => <integer>,
        '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' => <integer>,
        'Failures' => ['<string>', ...],
        'Id' => '<string>',
        'JobStatus' => 'CREATED|PREPARING_FOR_INITIALIZATION|INITIALIZING|PROCESSING|PENDING_JOB|COMPLETING|COMPLETED|FAILING|FAILED',
        'TotalFailures' => <integer>,
        'TotalPieces' => <integer>,
        'TotalProcessed' => <integer>,
        'Type' => '<string>',
    ],
]

Result Details

Members

ImportJobResponse

: Required: Yes
: Type: ImportJobResponse structure

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.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

CreateInAppTemplate

$result = $client->createInAppTemplate([/* ... */]);
$promise = $client->createInAppTemplateAsync([/* ... */]);

Creates a new message template for messages using the in-app message channel.

Parameter Syntax

$result = $client->createInAppTemplate([
    'InAppTemplateRequest' => [ // REQUIRED
        'Content' => [
            [
                'BackgroundColor' => '<string>',
                'BodyConfig' => [
                    'Alignment' => 'LEFT|CENTER|RIGHT', // REQUIRED
                    'Body' => '<string>', // REQUIRED
                    'TextColor' => '<string>', // REQUIRED
                ],
                'HeaderConfig' => [
                    'Alignment' => 'LEFT|CENTER|RIGHT', // REQUIRED
                    'Header' => '<string>', // REQUIRED
                    'TextColor' => '<string>', // REQUIRED
                ],
                'ImageUrl' => '<string>',
                'PrimaryBtn' => [
                    'Android' => [
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                    ],
                    'DefaultConfig' => [
                        'BackgroundColor' => '<string>',
                        'BorderRadius' => <integer>,
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                        'Text' => '<string>', // REQUIRED
                        'TextColor' => '<string>',
                    ],
                    'IOS' => [
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                    ],
                    'Web' => [
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                    ],
                ],
                'SecondaryBtn' => [
                    'Android' => [
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                    ],
                    'DefaultConfig' => [
                        'BackgroundColor' => '<string>',
                        'BorderRadius' => <integer>,
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                        'Text' => '<string>', // REQUIRED
                        'TextColor' => '<string>',
                    ],
                    'IOS' => [
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                    ],
                    'Web' => [
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'CustomConfig' => ['<string>', ...],
        'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
        'TemplateDescription' => '<string>',
        'tags' => ['<string>', ...],
    ],
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members

InAppTemplateRequest

: Required: Yes
: Type: InAppTemplateRequest structure

In-App Template Request.

TemplateName

: Required: Yes
: Type: string

Result Syntax

[
    'TemplateCreateMessageBody' => [
        'Arn' => '<string>',
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

TemplateCreateMessageBody

: Required: Yes
: Type: TemplateCreateMessageBody structure

Provides information about a request to create a message template.

Errors

MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.
BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.

CreateJourney

$result = $client->createJourney([/* ... */]);
$promise = $client->createJourneyAsync([/* ... */]);

Creates a journey for an application.

Parameter Syntax

$result = $client->createJourney([
    'ApplicationId' => '<string>', // REQUIRED
    'WriteJourneyRequest' => [ // REQUIRED
        'Activities' => [
            '<__string>' => [
                'CUSTOM' => [
                    'DeliveryUri' => '<string>',
                    'EndpointTypes' => ['<string>', ...],
                    'MessageConfig' => [
                        'Data' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'ConditionalSplit' => [
                    'Condition' => [
                        'Conditions' => [
                            [
                                'EventCondition' => [
                                    'Dimensions' => [
                                        'Attributes' => [
                                            '<__string>' => [
                                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                'Values' => ['<string>', ...], // REQUIRED
                                            ],
                                            // ...
                                        ],
                                        'EventType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Metrics' => [
                                            '<__string>' => [
                                                'ComparisonOperator' => '<string>', // REQUIRED
                                                'Value' => <float>, // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'MessageActivity' => '<string>',
                                ],
                                'SegmentCondition' => [
                                    'SegmentId' => '<string>', // REQUIRED
                                ],
                                'SegmentDimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'Behavior' => [
                                        'Recency' => [
                                            'Duration' => 'HR_24|DAY_7|DAY_14|DAY_30', // REQUIRED
                                            'RecencyType' => 'ACTIVE|INACTIVE', // REQUIRED
                                        ],
                                    ],
                                    'Demographic' => [
                                        'AppVersion' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Channel' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'DeviceType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Make' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Model' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Platform' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                    ],
                                    'Location' => [
                                        'Country' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'GPSPoint' => [
                                            'Coordinates' => [ // REQUIRED
                                                'Latitude' => <float>, // REQUIRED
                                                'Longitude' => <float>, // REQUIRED
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>', // REQUIRED
                                            'Value' => <float>, // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            // ...
                        ],
                        'Operator' => 'ALL|ANY',
                    ],
                    'EvaluationWaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                    'FalseActivity' => '<string>',
                    'TrueActivity' => '<string>',
                ],
                'ContactCenter' => [
                    'NextActivity' => '<string>',
                ],
                'Description' => '<string>',
                'EMAIL' => [
                    'MessageConfig' => [
                        'FromAddress' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'Holdout' => [
                    'NextActivity' => '<string>',
                    'Percentage' => <integer>, // REQUIRED
                ],
                'MultiCondition' => [
                    'Branches' => [
                        [
                            'Condition' => [
                                'EventCondition' => [
                                    'Dimensions' => [
                                        'Attributes' => [
                                            '<__string>' => [
                                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                'Values' => ['<string>', ...], // REQUIRED
                                            ],
                                            // ...
                                        ],
                                        'EventType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Metrics' => [
                                            '<__string>' => [
                                                'ComparisonOperator' => '<string>', // REQUIRED
                                                'Value' => <float>, // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'MessageActivity' => '<string>',
                                ],
                                'SegmentCondition' => [
                                    'SegmentId' => '<string>', // REQUIRED
                                ],
                                'SegmentDimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'Behavior' => [
                                        'Recency' => [
                                            'Duration' => 'HR_24|DAY_7|DAY_14|DAY_30', // REQUIRED
                                            'RecencyType' => 'ACTIVE|INACTIVE', // REQUIRED
                                        ],
                                    ],
                                    'Demographic' => [
                                        'AppVersion' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Channel' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'DeviceType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Make' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Model' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Platform' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                    ],
                                    'Location' => [
                                        'Country' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'GPSPoint' => [
                                            'Coordinates' => [ // REQUIRED
                                                'Latitude' => <float>, // REQUIRED
                                                'Longitude' => <float>, // REQUIRED
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>', // REQUIRED
                                            'Value' => <float>, // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            'NextActivity' => '<string>',
                        ],
                        // ...
                    ],
                    'DefaultActivity' => '<string>',
                    'EvaluationWaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                ],
                'PUSH' => [
                    'MessageConfig' => [
                        'TimeToLive' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'RandomSplit' => [
                    'Branches' => [
                        [
                            'NextActivity' => '<string>',
                            'Percentage' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'SMS' => [
                    'MessageConfig' => [
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'Wait' => [
                    'NextActivity' => '<string>',
                    'WaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'ClosedDays' => [
            'CUSTOM' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'EMAIL' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'PUSH' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'SMS' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'VOICE' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
        ],
        'CreationDate' => '<string>',
        'JourneyChannelSettings' => [
            'ConnectCampaignArn' => '<string>',
            'ConnectCampaignExecutionRoleArn' => '<string>',
        ],
        'LastModifiedDate' => '<string>',
        'Limits' => [
            'DailyCap' => <integer>,
            'EndpointReentryCap' => <integer>,
            'EndpointReentryInterval' => '<string>',
            'MessagesPerSecond' => <integer>,
            'TimeframeCap' => [
                'Cap' => <integer>,
                'Days' => <integer>,
            ],
            'TotalCap' => <integer>,
        ],
        'LocalTime' => true || false,
        'Name' => '<string>', // REQUIRED
        'OpenHours' => [
            'CUSTOM' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'EMAIL' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'PUSH' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'SMS' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'VOICE' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
        ],
        'QuietTime' => [
            'End' => '<string>',
            'Start' => '<string>',
        ],
        'RefreshFrequency' => '<string>',
        'RefreshOnSegmentUpdate' => true || false,
        'Schedule' => [
            'EndTime' => <integer || string || DateTime>,
            'StartTime' => <integer || string || DateTime>,
            'Timezone' => '<string>',
        ],
        'SendingSchedule' => true || false,
        'StartActivity' => '<string>',
        'StartCondition' => [
            'Description' => '<string>',
            'EventStartCondition' => [
                'EventFilter' => [
                    'Dimensions' => [ // REQUIRED
                        'Attributes' => [
                            '<__string>' => [
                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                'Values' => ['<string>', ...], // REQUIRED
                            ],
                            // ...
                        ],
                        'EventType' => [
                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                            'Values' => ['<string>', ...], // REQUIRED
                        ],
                        'Metrics' => [
                            '<__string>' => [
                                'ComparisonOperator' => '<string>', // REQUIRED
                                'Value' => <float>, // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    'FilterType' => 'SYSTEM|ENDPOINT', // REQUIRED
                ],
                'SegmentId' => '<string>',
            ],
            'SegmentStartCondition' => [
                'SegmentId' => '<string>', // REQUIRED
            ],
        ],
        'State' => 'DRAFT|ACTIVE|COMPLETED|CANCELLED|CLOSED|PAUSED',
        'TimezoneEstimationMethods' => ['<string>', ...],
        'WaitForQuietTime' => true || false,
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

WriteJourneyRequest

: Required: Yes
: Type: WriteJourneyRequest structure

Specifies the configuration and other settings for a journey.

Result Syntax

[
    'JourneyResponse' => [
        'Activities' => [
            '<__string>' => [
                'CUSTOM' => [
                    'DeliveryUri' => '<string>',
                    'EndpointTypes' => ['<string>', ...],
                    'MessageConfig' => [
                        'Data' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'ConditionalSplit' => [
                    'Condition' => [
                        'Conditions' => [
                            [
                                'EventCondition' => [
                                    'Dimensions' => [
                                        'Attributes' => [
                                            '<__string>' => [
                                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                'Values' => ['<string>', ...],
                                            ],
                                            // ...
                                        ],
                                        'EventType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...],
                                        ],
                                        'Metrics' => [
                                            '<__string>' => [
                                                'ComparisonOperator' => '<string>',
                                                'Value' => <float>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'MessageActivity' => '<string>',
                                ],
                                'SegmentCondition' => [
                                    'SegmentId' => '<string>',
                                ],
                                'SegmentDimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <float>,
                                                'Longitude' => <float>,
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>',
                                            'Value' => <float>,
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            // ...
                        ],
                        'Operator' => 'ALL|ANY',
                    ],
                    'EvaluationWaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                    'FalseActivity' => '<string>',
                    'TrueActivity' => '<string>',
                ],
                'ContactCenter' => [
                    'NextActivity' => '<string>',
                ],
                'Description' => '<string>',
                'EMAIL' => [
                    'MessageConfig' => [
                        'FromAddress' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'Holdout' => [
                    'NextActivity' => '<string>',
                    'Percentage' => <integer>,
                ],
                'MultiCondition' => [
                    'Branches' => [
                        [
                            'Condition' => [
                                'EventCondition' => [
                                    'Dimensions' => [
                                        'Attributes' => [
                                            '<__string>' => [
                                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                'Values' => ['<string>', ...],
                                            ],
                                            // ...
                                        ],
                                        'EventType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...],
                                        ],
                                        'Metrics' => [
                                            '<__string>' => [
                                                'ComparisonOperator' => '<string>',
                                                'Value' => <float>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'MessageActivity' => '<string>',
                                ],
                                'SegmentCondition' => [
                                    'SegmentId' => '<string>',
                                ],
                                'SegmentDimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <float>,
                                                'Longitude' => <float>,
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>',
                                            'Value' => <float>,
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'SMS' => [
                    'MessageConfig' => [
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'Wait' => [
                    'NextActivity' => '<string>',
                    'WaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'ApplicationId' => '<string>',
        'ClosedDays' => [
            'CUSTOM' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'EMAIL' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'PUSH' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'SMS' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'VOICE' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
        ],
        'CreationDate' => '<string>',
        'Id' => '<string>',
        'JourneyChannelSettings' => [
            'ConnectCampaignArn' => '<string>',
            'ConnectCampaignExecutionRoleArn' => '<string>',
        ],
        'LastModifiedDate' => '<string>',
        'Limits' => [
            'DailyCap' => <integer>,
            'EndpointReentryCap' => <integer>,
            'EndpointReentryInterval' => '<string>',
            'MessagesPerSecond' => <integer>,
            'TimeframeCap' => [
                'Cap' => <integer>,
                'Days' => <integer>,
            ],
            'TotalCap' => <integer>,
        ],
        'LocalTime' => true || false,
        'Name' => '<string>',
        'OpenHours' => [
            'CUSTOM' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'EMAIL' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'PUSH' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'SMS' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'VOICE' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
        ],
        'QuietTime' => [
            'End' => '<string>',
            'Start' => '<string>',
        ],
        'RefreshFrequency' => '<string>',
        'RefreshOnSegmentUpdate' => true || false,
        'Schedule' => [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
            'Timezone' => '<string>',
        ],
        'SendingSchedule' => true || false,
        'StartActivity' => '<string>',
        'StartCondition' => [
            'Description' => '<string>',
            'EventStartCondition' => [
                'EventFilter' => [
                    'Dimensions' => [
                        'Attributes' => [
                            '<__string>' => [
                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                'Values' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'EventType' => [
                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                            'Values' => ['<string>', ...],
                        ],
                        'Metrics' => [
                            '<__string>' => [
                                'ComparisonOperator' => '<string>',
                                'Value' => <float>,
                            ],
                            // ...
                        ],
                    ],
                    'FilterType' => 'SYSTEM|ENDPOINT',
                ],
                'SegmentId' => '<string>',
            ],
            'SegmentStartCondition' => [
                'SegmentId' => '<string>',
            ],
        ],
        'State' => 'DRAFT|ACTIVE|COMPLETED|CANCELLED|CLOSED|PAUSED',
        'TimezoneEstimationMethods' => ['<string>', ...],
        'WaitForQuietTime' => true || false,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

JourneyResponse

: Required: Yes
: Type: JourneyResponse structure

Provides information about the status, configuration, and other settings for a journey.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

CreatePushTemplate

$result = $client->createPushTemplate([/* ... */]);
$promise = $client->createPushTemplateAsync([/* ... */]);

Creates a message template for messages that are sent through a push notification channel.

Parameter Syntax

$result = $client->createPushTemplate([
    'PushNotificationTemplateRequest' => [ // REQUIRED
        '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>',
        'TemplateDescription' => '<string>',
        'tags' => ['<string>', ...],
    ],
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members

PushNotificationTemplateRequest

: Required: Yes
: Type: PushNotificationTemplateRequest structure

Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

TemplateName

: Required: Yes
: Type: string

Result Syntax

[
    'CreateTemplateMessageBody' => [
        'Arn' => '<string>',
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

CreateTemplateMessageBody

: Required: Yes
: Type: CreateTemplateMessageBody structure

Provides information about a request to create a message template.

Errors

MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.
BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.

CreateRecommenderConfiguration

$result = $client->createRecommenderConfiguration([/* ... */]);
$promise = $client->createRecommenderConfigurationAsync([/* ... */]);

Creates an Amazon Pinpoint configuration for a recommender model.

Parameter Syntax

$result = $client->createRecommenderConfiguration([
    'CreateRecommenderConfiguration' => [ // REQUIRED
        'Attributes' => ['<string>', ...],
        'Description' => '<string>',
        'Name' => '<string>',
        'RecommendationProviderIdType' => '<string>',
        'RecommendationProviderRoleArn' => '<string>', // REQUIRED
        'RecommendationProviderUri' => '<string>', // REQUIRED
        'RecommendationTransformerUri' => '<string>',
        'RecommendationsDisplayName' => '<string>',
        'RecommendationsPerMessage' => <integer>,
    ],
]);

Parameter Details

Members

CreateRecommenderConfiguration

: Required: Yes
: Type: CreateRecommenderConfiguration structure

Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

Result Syntax

[
    'RecommenderConfigurationResponse' => [
        'Attributes' => ['<string>', ...],
        'CreationDate' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'LastModifiedDate' => '<string>',
        'Name' => '<string>',
        'RecommendationProviderIdType' => '<string>',
        'RecommendationProviderRoleArn' => '<string>',
        'RecommendationProviderUri' => '<string>',
        'RecommendationTransformerUri' => '<string>',
        'RecommendationsDisplayName' => '<string>',
        'RecommendationsPerMessage' => <integer>,
    ],
]

Result Details

Members

RecommenderConfigurationResponse

: Required: Yes
: Type: RecommenderConfigurationResponse structure

Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

CreateSegment

$result = $client->createSegment([/* ... */]);
$promise = $client->createSegmentAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createSegment([
    'ApplicationId' => '<string>', // REQUIRED
    'WriteSegmentRequest' => [ // REQUIRED
        'Dimensions' => [
            'Attributes' => [
                '<__string>' => [
                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'Behavior' => [
                'Recency' => [
                    'Duration' => 'HR_24|DAY_7|DAY_14|DAY_30', // REQUIRED
                    'RecencyType' => 'ACTIVE|INACTIVE', // REQUIRED
                ],
            ],
            'Demographic' => [
                'AppVersion' => [
                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                'Channel' => [
                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                'DeviceType' => [
                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                'Make' => [
                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                'Model' => [
                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                'Platform' => [
                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
            ],
            'Location' => [
                'Country' => [
                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                'GPSPoint' => [
                    'Coordinates' => [ // REQUIRED
                        'Latitude' => <float>, // REQUIRED
                        'Longitude' => <float>, // REQUIRED
                    ],
                    'RangeInKilometers' => <float>,
                ],
            ],
            'Metrics' => [
                '<__string>' => [
                    'ComparisonOperator' => '<string>', // REQUIRED
                    'Value' => <float>, // REQUIRED
                ],
                // ...
            ],
            'UserAttributes' => [
                '<__string>' => [
                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
        ],
        'Name' => '<string>',
        'SegmentGroups' => [
            'Groups' => [
                [
                    'Dimensions' => [
                        [
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                // ...
                            ],
                            'Behavior' => [
                                'Recency' => [
                                    'Duration' => 'HR_24|DAY_7|DAY_14|DAY_30', // REQUIRED
                                    'RecencyType' => 'ACTIVE|INACTIVE', // REQUIRED
                                ],
                            ],
                            'Demographic' => [
                                'AppVersion' => [
                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                'Channel' => [
                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                'DeviceType' => [
                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                'Make' => [
                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                'Model' => [
                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                'Platform' => [
                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                            ],
                            'Location' => [
                                'Country' => [
                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                'GPSPoint' => [
                                    'Coordinates' => [ // REQUIRED
                                        'Latitude' => <float>, // REQUIRED
                                        'Longitude' => <float>, // REQUIRED
                                    ],
                                    'RangeInKilometers' => <float>,
                                ],
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>', // REQUIRED
                                    'Value' => <float>, // REQUIRED
                                ],
                                // ...
                            ],
                            'UserAttributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'SourceSegments' => [
                        [
                            'Id' => '<string>', // REQUIRED
                            'Version' => <integer>,
                        ],
                        // ...
                    ],
                    'SourceType' => 'ALL|ANY|NONE',
                    'Type' => 'ALL|ANY|NONE',
                ],
                // ...
            ],
            'Include' => 'ALL|ANY|NONE',
        ],
        'tags' => ['<string>', ...],
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

WriteSegmentRequest

: Required: Yes
: Type: WriteSegmentRequest structure

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.

Result Syntax

[
    'SegmentResponse' => [
        'ApplicationId' => '<string>',
        'Arn' => '<string>',
        'CreationDate' => '<string>',
        'Dimensions' => [
            'Attributes' => [
                '<__string>' => [
                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                    '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' => <float>,
                        'Longitude' => <float>,
                    ],
                    'RangeInKilometers' => <float>,
                ],
            ],
            'Metrics' => [
                '<__string>' => [
                    'ComparisonOperator' => '<string>',
                    'Value' => <float>,
                ],
                // ...
            ],
            'UserAttributes' => [
                '<__string>' => [
                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'Id' => '<string>',
        'ImportDefinition' => [
            'ChannelCounts' => [<integer>, ...],
            'ExternalId' => '<string>',
            'Format' => 'CSV|JSON',
            'RoleArn' => '<string>',
            'S3Url' => '<string>',
            'Size' => <integer>,
        ],
        'LastModifiedDate' => '<string>',
        'Name' => '<string>',
        'SegmentGroups' => [
            'Groups' => [
                [
                    'Dimensions' => [
                        [
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    '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' => <float>,
                                        'Longitude' => <float>,
                                    ],
                                    'RangeInKilometers' => <float>,
                                ],
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>',
                                    'Value' => <float>,
                                ],
                                // ...
                            ],
                            'UserAttributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'SourceSegments' => [
                        [
                            'Id' => '<string>',
                            'Version' => <integer>,
                        ],
                        // ...
                    ],
                    'SourceType' => 'ALL|ANY|NONE',
                    'Type' => 'ALL|ANY|NONE',
                ],
                // ...
            ],
            'Include' => 'ALL|ANY|NONE',
        ],
        'SegmentType' => 'DIMENSIONAL|IMPORT',
        'Version' => <integer>,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

SegmentResponse

: Required: Yes
: Type: SegmentResponse structure

Provides information about the configuration, dimension, and other settings for a segment.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

CreateSmsTemplate

$result = $client->createSmsTemplate([/* ... */]);
$promise = $client->createSmsTemplateAsync([/* ... */]);

Creates a message template for messages that are sent through the SMS channel.

Parameter Syntax

$result = $client->createSmsTemplate([
    'SMSTemplateRequest' => [ // REQUIRED
        'Body' => '<string>',
        'DefaultSubstitutions' => '<string>',
        'RecommenderId' => '<string>',
        'TemplateDescription' => '<string>',
        'tags' => ['<string>', ...],
    ],
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members

SMSTemplateRequest

: Required: Yes
: Type: SMSTemplateRequest structure

Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

TemplateName

: Required: Yes
: Type: string

Result Syntax

[
    'CreateTemplateMessageBody' => [
        'Arn' => '<string>',
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

CreateTemplateMessageBody

: Required: Yes
: Type: CreateTemplateMessageBody structure

Provides information about a request to create a message template.

Errors

MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.
BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.

CreateVoiceTemplate

$result = $client->createVoiceTemplate([/* ... */]);
$promise = $client->createVoiceTemplateAsync([/* ... */]);

Creates a message template for messages that are sent through the voice channel.

Parameter Syntax

$result = $client->createVoiceTemplate([
    'TemplateName' => '<string>', // REQUIRED
    'VoiceTemplateRequest' => [ // REQUIRED
        'Body' => '<string>',
        'DefaultSubstitutions' => '<string>',
        'LanguageCode' => '<string>',
        'TemplateDescription' => '<string>',
        'VoiceId' => '<string>',
        'tags' => ['<string>', ...],
    ],
]);

Parameter Details

Members

TemplateName

: Required: Yes
: Type: string

VoiceTemplateRequest

: Required: Yes
: Type: VoiceTemplateRequest structure

Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

Result Syntax

[
    'CreateTemplateMessageBody' => [
        'Arn' => '<string>',
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

CreateTemplateMessageBody

: Required: Yes
: Type: CreateTemplateMessageBody structure

Provides information about a request to create a message template.

Errors

MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.
BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.

DeleteAdmChannel

$result = $client->deleteAdmChannel([/* ... */]);
$promise = $client->deleteAdmChannelAsync([/* ... */]);

Disables the ADM channel for an application and deletes any existing settings for the channel.

Parameter Syntax

$result = $client->deleteAdmChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result Syntax

[
    'ADMChannelResponse' => [
        'ApplicationId' => '<string>',
        'CreationDate' => '<string>',
        'Enabled' => true || false,
        'HasCredential' => true || false,
        'Id' => '<string>',
        'IsArchived' => true || false,
        'LastModifiedBy' => '<string>',
        'LastModifiedDate' => '<string>',
        'Platform' => '<string>',
        'Version' => <integer>,
    ],
]

Result Details

Members

ADMChannelResponse

: Required: Yes
: Type: ADMChannelResponse structure

Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteApnsChannel

$result = $client->deleteApnsChannel([/* ... */]);
$promise = $client->deleteApnsChannelAsync([/* ... */]);

Disables the APNs channel for an application and deletes any existing settings for the channel.

Parameter Syntax

$result = $client->deleteApnsChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
    ],
]

Result Details

Members

APNSChannelResponse

: Required: Yes
: Type: APNSChannelResponse structure

Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteApnsSandboxChannel

$result = $client->deleteApnsSandboxChannel([/* ... */]);
$promise = $client->deleteApnsSandboxChannelAsync([/* ... */]);

Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.

Parameter Syntax

$result = $client->deleteApnsSandboxChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
    ],
]

Result Details

Members

APNSSandboxChannelResponse

: Required: Yes
: Type: APNSSandboxChannelResponse structure

Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteApnsVoipChannel

$result = $client->deleteApnsVoipChannel([/* ... */]);
$promise = $client->deleteApnsVoipChannelAsync([/* ... */]);

Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.

Parameter Syntax

$result = $client->deleteApnsVoipChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
    ],
]

Result Details

Members

APNSVoipChannelResponse

: Required: Yes
: Type: APNSVoipChannelResponse structure

Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteApnsVoipSandboxChannel

$result = $client->deleteApnsVoipSandboxChannel([/* ... */]);
$promise = $client->deleteApnsVoipSandboxChannelAsync([/* ... */]);

Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.

Parameter Syntax

$result = $client->deleteApnsVoipSandboxChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
    ],
]

Result Details

Members

APNSVoipSandboxChannelResponse

: Required: Yes
: Type: APNSVoipSandboxChannelResponse structure

Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteApp

$result = $client->deleteApp([/* ... */]);
$promise = $client->deleteAppAsync([/* ... */]);

Deletes an application.

Parameter Syntax

$result = $client->deleteApp([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result Syntax

[
    'ApplicationResponse' => [
        'Arn' => '<string>',
        'CreationDate' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

ApplicationResponse

: Required: Yes
: Type: ApplicationResponse structure

Provides information about an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteBaiduChannel

$result = $client->deleteBaiduChannel([/* ... */]);
$promise = $client->deleteBaiduChannelAsync([/* ... */]);

Disables the Baidu channel for an application and deletes any existing settings for the channel.

Parameter Syntax

$result = $client->deleteBaiduChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
    ],
]

Result Details

Members

BaiduChannelResponse

: Required: Yes
: Type: BaiduChannelResponse structure

Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteCampaign

$result = $client->deleteCampaign([/* ... */]);
$promise = $client->deleteCampaignAsync([/* ... */]);

Deletes a campaign from an application.

Parameter Syntax

$result = $client->deleteCampaign([
    'ApplicationId' => '<string>', // REQUIRED
    'CampaignId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

CampaignId

: Required: Yes
: Type: string

Result Syntax

[
    'CampaignResponse' => [
        'AdditionalTreatments' => [
            [
                'CustomDeliveryConfiguration' => [
                    'DeliveryUri' => '<string>',
                    'EndpointTypes' => ['<string>', ...],
                ],
                '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<string>',
                    ],
                    'EmailMessage' => [
                        'Body' => '<string>',
                        'FromAddress' => '<string>',
                        'Headers' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<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' => <integer>,
                                        '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' => <integer>,
                                        '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>', ...],
                        'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
                    ],
                    'SMSMessage' => [
                        'Body' => '<string>',
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                ],
                'Schedule' => [
                    'EndTime' => '<string>',
                    'EventFilter' => [
                        'Dimensions' => [
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'EventType' => [
                                'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                'Values' => ['<string>', ...],
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>',
                                    'Value' => <float>,
                                ],
                                // ...
                            ],
                        ],
                        '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' => <integer>,
                'State' => [
                    'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
                ],
                'TemplateConfiguration' => [
                    'EmailTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                    'InAppTemplate' => [
                        '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' => ['<string>', ...],
        ],
        'DefaultState' => [
            'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
        ],
        'Description' => '<string>',
        'HoldoutPercent' => <integer>,
        'Hook' => [
            'LambdaFunctionName' => '<string>',
            'Mode' => 'DELIVERY|FILTER',
            'WebUrl' => '<string>',
        ],
        'Id' => '<string>',
        'IsPaused' => true || false,
        'LastModifiedDate' => '<string>',
        'Limits' => [
            'Daily' => <integer>,
            'MaximumDuration' => <integer>,
            'MessagesPerSecond' => <integer>,
            'Session' => <integer>,
            'Total' => <integer>,
        ],
        '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' => <integer>,
                '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' => <integer>,
                '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' => <integer>,
                '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' => <integer>,
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'EmailMessage' => [
                'Body' => '<string>',
                'FromAddress' => '<string>',
                'Headers' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<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' => <integer>,
                'Title' => '<string>',
                'Url' => '<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' => <integer>,
                                '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' => <integer>,
                                '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>', ...],
                'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
            ],
            'SMSMessage' => [
                'Body' => '<string>',
                'EntityId' => '<string>',
                'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                'OriginationNumber' => '<string>',
                'SenderId' => '<string>',
                'TemplateId' => '<string>',
            ],
        ],
        'Name' => '<string>',
        'Priority' => <integer>,
        'Schedule' => [
            'EndTime' => '<string>',
            'EventFilter' => [
                'Dimensions' => [
                    'Attributes' => [
                        '<__string>' => [
                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                            'Values' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'EventType' => [
                        'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                        'Values' => ['<string>', ...],
                    ],
                    'Metrics' => [
                        '<__string>' => [
                            'ComparisonOperator' => '<string>',
                            'Value' => <float>,
                        ],
                        // ...
                    ],
                ],
                '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' => <integer>,
        'State' => [
            'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
        ],
        'TemplateConfiguration' => [
            'EmailTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'InAppTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'PushTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'SMSTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'VoiceTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
        ],
        'TreatmentDescription' => '<string>',
        'TreatmentName' => '<string>',
        'Version' => <integer>,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

CampaignResponse

: Required: Yes
: Type: CampaignResponse structure

Provides information about the status, configuration, and other settings for a campaign.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteEmailChannel

$result = $client->deleteEmailChannel([/* ... */]);
$promise = $client->deleteEmailChannelAsync([/* ... */]);

Disables the email channel for an application and deletes any existing settings for the channel.

Parameter Syntax

$result = $client->deleteEmailChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
        'OrchestrationSendingRoleArn' => '<string>',
        'Platform' => '<string>',
        'RoleArn' => '<string>',
        'Version' => <integer>,
    ],
]

Result Details

Members

EmailChannelResponse

: Required: Yes
: Type: EmailChannelResponse structure

Provides information about the status and settings of the email channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteEmailTemplate

$result = $client->deleteEmailTemplate([/* ... */]);
$promise = $client->deleteEmailTemplateAsync([/* ... */]);

Deletes a message template for messages that were sent through the email channel.

Parameter Syntax

$result = $client->deleteEmailTemplate([
    'TemplateName' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members

TemplateName

: Required: Yes
: Type: string

Version

: Type: string

Result Syntax

[
    'MessageBody' => [
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

MessageBody

: Required: Yes
: Type: MessageBody structure

Provides information about an API request or response.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteEndpoint

$result = $client->deleteEndpoint([/* ... */]);
$promise = $client->deleteEndpointAsync([/* ... */]);

Deletes an endpoint from an application.

Parameter Syntax

$result = $client->deleteEndpoint([
    'ApplicationId' => '<string>', // REQUIRED
    'EndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

EndpointId

: Required: Yes
: Type: string

Result 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' => <float>,
            'Longitude' => <float>,
            'PostalCode' => '<string>',
            'Region' => '<string>',
        ],
        'Metrics' => [<float>, ...],
        'OptOut' => '<string>',
        'RequestId' => '<string>',
        'User' => [
            'UserAttributes' => [
                '<__string>' => ['<string>', ...],
                // ...
            ],
            'UserId' => '<string>',
        ],
    ],
]

Result Details

Members

EndpointResponse

: Required: Yes
: Type: EndpointResponse structure

Provides information about the channel type and other settings for an endpoint.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteEventStream

$result = $client->deleteEventStream([/* ... */]);
$promise = $client->deleteEventStreamAsync([/* ... */]);

Deletes the event stream for an application.

Parameter Syntax

$result = $client->deleteEventStream([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result Syntax

[
    'EventStream' => [
        'ApplicationId' => '<string>',
        'DestinationStreamArn' => '<string>',
        'ExternalId' => '<string>',
        'LastModifiedDate' => '<string>',
        'LastUpdatedBy' => '<string>',
        'RoleArn' => '<string>',
    ],
]

Result Details

Members

EventStream

: Required: Yes
: Type: EventStream structure

Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteGcmChannel

$result = $client->deleteGcmChannel([/* ... */]);
$promise = $client->deleteGcmChannelAsync([/* ... */]);

Disables the GCM channel for an application and deletes any existing settings for the channel.

Parameter Syntax

$result = $client->deleteGcmChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result Syntax

[
    'GCMChannelResponse' => [
        'ApplicationId' => '<string>',
        'CreationDate' => '<string>',
        'Credential' => '<string>',
        'DefaultAuthenticationMethod' => '<string>',
        'Enabled' => true || false,
        'HasCredential' => true || false,
        'HasFcmServiceCredentials' => true || false,
        'Id' => '<string>',
        'IsArchived' => true || false,
        'LastModifiedBy' => '<string>',
        'LastModifiedDate' => '<string>',
        'Platform' => '<string>',
        'Version' => <integer>,
    ],
]

Result Details

Members

GCMChannelResponse

: Required: Yes
: Type: GCMChannelResponse structure

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.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteInAppTemplate

$result = $client->deleteInAppTemplate([/* ... */]);
$promise = $client->deleteInAppTemplateAsync([/* ... */]);

Deletes a message template for messages sent using the in-app message channel.

Parameter Syntax

$result = $client->deleteInAppTemplate([
    'TemplateName' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members

TemplateName

: Required: Yes
: Type: string

Version

: Type: string

Result Syntax

[
    'MessageBody' => [
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

MessageBody

: Required: Yes
: Type: MessageBody structure

Provides information about an API request or response.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteJourney

$result = $client->deleteJourney([/* ... */]);
$promise = $client->deleteJourneyAsync([/* ... */]);

Deletes a journey from an application.

Parameter Syntax

$result = $client->deleteJourney([
    'ApplicationId' => '<string>', // REQUIRED
    'JourneyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

JourneyId

: Required: Yes
: Type: string

Result Syntax

[
    'JourneyResponse' => [
        'Activities' => [
            '<__string>' => [
                'CUSTOM' => [
                    'DeliveryUri' => '<string>',
                    'EndpointTypes' => ['<string>', ...],
                    'MessageConfig' => [
                        'Data' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'ConditionalSplit' => [
                    'Condition' => [
                        'Conditions' => [
                            [
                                'EventCondition' => [
                                    'Dimensions' => [
                                        'Attributes' => [
                                            '<__string>' => [
                                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                'Values' => ['<string>', ...],
                                            ],
                                            // ...
                                        ],
                                        'EventType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...],
                                        ],
                                        'Metrics' => [
                                            '<__string>' => [
                                                'ComparisonOperator' => '<string>',
                                                'Value' => <float>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'MessageActivity' => '<string>',
                                ],
                                'SegmentCondition' => [
                                    'SegmentId' => '<string>',
                                ],
                                'SegmentDimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <float>,
                                                'Longitude' => <float>,
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>',
                                            'Value' => <float>,
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            // ...
                        ],
                        'Operator' => 'ALL|ANY',
                    ],
                    'EvaluationWaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                    'FalseActivity' => '<string>',
                    'TrueActivity' => '<string>',
                ],
                'ContactCenter' => [
                    'NextActivity' => '<string>',
                ],
                'Description' => '<string>',
                'EMAIL' => [
                    'MessageConfig' => [
                        'FromAddress' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'Holdout' => [
                    'NextActivity' => '<string>',
                    'Percentage' => <integer>,
                ],
                'MultiCondition' => [
                    'Branches' => [
                        [
                            'Condition' => [
                                'EventCondition' => [
                                    'Dimensions' => [
                                        'Attributes' => [
                                            '<__string>' => [
                                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                'Values' => ['<string>', ...],
                                            ],
                                            // ...
                                        ],
                                        'EventType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...],
                                        ],
                                        'Metrics' => [
                                            '<__string>' => [
                                                'ComparisonOperator' => '<string>',
                                                'Value' => <float>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'MessageActivity' => '<string>',
                                ],
                                'SegmentCondition' => [
                                    'SegmentId' => '<string>',
                                ],
                                'SegmentDimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <float>,
                                                'Longitude' => <float>,
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>',
                                            'Value' => <float>,
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'SMS' => [
                    'MessageConfig' => [
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'Wait' => [
                    'NextActivity' => '<string>',
                    'WaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'ApplicationId' => '<string>',
        'ClosedDays' => [
            'CUSTOM' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'EMAIL' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'PUSH' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'SMS' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'VOICE' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
        ],
        'CreationDate' => '<string>',
        'Id' => '<string>',
        'JourneyChannelSettings' => [
            'ConnectCampaignArn' => '<string>',
            'ConnectCampaignExecutionRoleArn' => '<string>',
        ],
        'LastModifiedDate' => '<string>',
        'Limits' => [
            'DailyCap' => <integer>,
            'EndpointReentryCap' => <integer>,
            'EndpointReentryInterval' => '<string>',
            'MessagesPerSecond' => <integer>,
            'TimeframeCap' => [
                'Cap' => <integer>,
                'Days' => <integer>,
            ],
            'TotalCap' => <integer>,
        ],
        'LocalTime' => true || false,
        'Name' => '<string>',
        'OpenHours' => [
            'CUSTOM' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'EMAIL' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'PUSH' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'SMS' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'VOICE' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
        ],
        'QuietTime' => [
            'End' => '<string>',
            'Start' => '<string>',
        ],
        'RefreshFrequency' => '<string>',
        'RefreshOnSegmentUpdate' => true || false,
        'Schedule' => [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
            'Timezone' => '<string>',
        ],
        'SendingSchedule' => true || false,
        'StartActivity' => '<string>',
        'StartCondition' => [
            'Description' => '<string>',
            'EventStartCondition' => [
                'EventFilter' => [
                    'Dimensions' => [
                        'Attributes' => [
                            '<__string>' => [
                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                'Values' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'EventType' => [
                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                            'Values' => ['<string>', ...],
                        ],
                        'Metrics' => [
                            '<__string>' => [
                                'ComparisonOperator' => '<string>',
                                'Value' => <float>,
                            ],
                            // ...
                        ],
                    ],
                    'FilterType' => 'SYSTEM|ENDPOINT',
                ],
                'SegmentId' => '<string>',
            ],
            'SegmentStartCondition' => [
                'SegmentId' => '<string>',
            ],
        ],
        'State' => 'DRAFT|ACTIVE|COMPLETED|CANCELLED|CLOSED|PAUSED',
        'TimezoneEstimationMethods' => ['<string>', ...],
        'WaitForQuietTime' => true || false,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

JourneyResponse

: Required: Yes
: Type: JourneyResponse structure

Provides information about the status, configuration, and other settings for a journey.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeletePushTemplate

$result = $client->deletePushTemplate([/* ... */]);
$promise = $client->deletePushTemplateAsync([/* ... */]);

Deletes a message template for messages that were sent through a push notification channel.

Parameter Syntax

$result = $client->deletePushTemplate([
    'TemplateName' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members

TemplateName

: Required: Yes
: Type: string

Version

: Type: string

Result Syntax

[
    'MessageBody' => [
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

MessageBody

: Required: Yes
: Type: MessageBody structure

Provides information about an API request or response.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteRecommenderConfiguration

$result = $client->deleteRecommenderConfiguration([/* ... */]);
$promise = $client->deleteRecommenderConfigurationAsync([/* ... */]);

Deletes an Amazon Pinpoint configuration for a recommender model.

Parameter Syntax

$result = $client->deleteRecommenderConfiguration([
    'RecommenderId' => '<string>', // REQUIRED
]);

Parameter Details

Members

RecommenderId

: Required: Yes
: Type: string

Result Syntax

[
    'RecommenderConfigurationResponse' => [
        'Attributes' => ['<string>', ...],
        'CreationDate' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'LastModifiedDate' => '<string>',
        'Name' => '<string>',
        'RecommendationProviderIdType' => '<string>',
        'RecommendationProviderRoleArn' => '<string>',
        'RecommendationProviderUri' => '<string>',
        'RecommendationTransformerUri' => '<string>',
        'RecommendationsDisplayName' => '<string>',
        'RecommendationsPerMessage' => <integer>,
    ],
]

Result Details

Members

RecommenderConfigurationResponse

: Required: Yes
: Type: RecommenderConfigurationResponse structure

Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteSegment

$result = $client->deleteSegment([/* ... */]);
$promise = $client->deleteSegmentAsync([/* ... */]);

Deletes a segment from an application.

Parameter Syntax

$result = $client->deleteSegment([
    'ApplicationId' => '<string>', // REQUIRED
    'SegmentId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

SegmentId

: Required: Yes
: Type: string

Result Syntax

[
    'SegmentResponse' => [
        'ApplicationId' => '<string>',
        'Arn' => '<string>',
        'CreationDate' => '<string>',
        'Dimensions' => [
            'Attributes' => [
                '<__string>' => [
                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                    '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' => <float>,
                        'Longitude' => <float>,
                    ],
                    'RangeInKilometers' => <float>,
                ],
            ],
            'Metrics' => [
                '<__string>' => [
                    'ComparisonOperator' => '<string>',
                    'Value' => <float>,
                ],
                // ...
            ],
            'UserAttributes' => [
                '<__string>' => [
                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'Id' => '<string>',
        'ImportDefinition' => [
            'ChannelCounts' => [<integer>, ...],
            'ExternalId' => '<string>',
            'Format' => 'CSV|JSON',
            'RoleArn' => '<string>',
            'S3Url' => '<string>',
            'Size' => <integer>,
        ],
        'LastModifiedDate' => '<string>',
        'Name' => '<string>',
        'SegmentGroups' => [
            'Groups' => [
                [
                    'Dimensions' => [
                        [
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    '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' => <float>,
                                        'Longitude' => <float>,
                                    ],
                                    'RangeInKilometers' => <float>,
                                ],
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>',
                                    'Value' => <float>,
                                ],
                                // ...
                            ],
                            'UserAttributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'SourceSegments' => [
                        [
                            'Id' => '<string>',
                            'Version' => <integer>,
                        ],
                        // ...
                    ],
                    'SourceType' => 'ALL|ANY|NONE',
                    'Type' => 'ALL|ANY|NONE',
                ],
                // ...
            ],
            'Include' => 'ALL|ANY|NONE',
        ],
        'SegmentType' => 'DIMENSIONAL|IMPORT',
        'Version' => <integer>,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

SegmentResponse

: Required: Yes
: Type: SegmentResponse structure

Provides information about the configuration, dimension, and other settings for a segment.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteSmsChannel

$result = $client->deleteSmsChannel([/* ... */]);
$promise = $client->deleteSmsChannelAsync([/* ... */]);

Disables the SMS channel for an application and deletes any existing settings for the channel.

Parameter Syntax

$result = $client->deleteSmsChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result Syntax

[
    'SMSChannelResponse' => [
        'ApplicationId' => '<string>',
        'CreationDate' => '<string>',
        'Enabled' => true || false,
        'HasCredential' => true || false,
        'Id' => '<string>',
        'IsArchived' => true || false,
        'LastModifiedBy' => '<string>',
        'LastModifiedDate' => '<string>',
        'Platform' => '<string>',
        'PromotionalMessagesPerSecond' => <integer>,
        'SenderId' => '<string>',
        'ShortCode' => '<string>',
        'TransactionalMessagesPerSecond' => <integer>,
        'Version' => <integer>,
    ],
]

Result Details

Members

SMSChannelResponse

: Required: Yes
: Type: SMSChannelResponse structure

Provides information about the status and settings of the SMS channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteSmsTemplate

$result = $client->deleteSmsTemplate([/* ... */]);
$promise = $client->deleteSmsTemplateAsync([/* ... */]);

Deletes a message template for messages that were sent through the SMS channel.

Parameter Syntax

$result = $client->deleteSmsTemplate([
    'TemplateName' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members

TemplateName

: Required: Yes
: Type: string

Version

: Type: string

Result Syntax

[
    'MessageBody' => [
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

MessageBody

: Required: Yes
: Type: MessageBody structure

Provides information about an API request or response.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteUserEndpoints

$result = $client->deleteUserEndpoints([/* ... */]);
$promise = $client->deleteUserEndpointsAsync([/* ... */]);

Deletes all the endpoints that are associated with a specific user ID.

Parameter Syntax

$result = $client->deleteUserEndpoints([
    'ApplicationId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

UserId

: Required: Yes
: Type: string

Result 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' => <float>,
                    'Longitude' => <float>,
                    'PostalCode' => '<string>',
                    'Region' => '<string>',
                ],
                'Metrics' => [<float>, ...],
                'OptOut' => '<string>',
                'RequestId' => '<string>',
                'User' => [
                    'UserAttributes' => [
                        '<__string>' => ['<string>', ...],
                        // ...
                    ],
                    'UserId' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members

EndpointsResponse

: Required: Yes
: Type: EndpointsResponse structure

Provides information about all the endpoints that are associated with a user ID.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteVoiceChannel

$result = $client->deleteVoiceChannel([/* ... */]);
$promise = $client->deleteVoiceChannelAsync([/* ... */]);

Disables the voice channel for an application and deletes any existing settings for the channel.

Parameter Syntax

$result = $client->deleteVoiceChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result Syntax

[
    'VoiceChannelResponse' => [
        'ApplicationId' => '<string>',
        'CreationDate' => '<string>',
        'Enabled' => true || false,
        'HasCredential' => true || false,
        'Id' => '<string>',
        'IsArchived' => true || false,
        'LastModifiedBy' => '<string>',
        'LastModifiedDate' => '<string>',
        'Platform' => '<string>',
        'Version' => <integer>,
    ],
]

Result Details

Members

VoiceChannelResponse

: Required: Yes
: Type: VoiceChannelResponse structure

Provides information about the status and settings of the voice channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

DeleteVoiceTemplate

$result = $client->deleteVoiceTemplate([/* ... */]);
$promise = $client->deleteVoiceTemplateAsync([/* ... */]);

Deletes a message template for messages that were sent through the voice channel.

Parameter Syntax

$result = $client->deleteVoiceTemplate([
    'TemplateName' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members

TemplateName

: Required: Yes
: Type: string

Version

: Type: string

Result Syntax

[
    'MessageBody' => [
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

MessageBody

: Required: Yes
: Type: MessageBody structure

Provides information about an API request or response.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetAdmChannel

$result = $client->getAdmChannel([/* ... */]);
$promise = $client->getAdmChannelAsync([/* ... */]);

Retrieves information about the status and settings of the ADM channel for an application.

Parameter Syntax

$result = $client->getAdmChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result Syntax

[
    'ADMChannelResponse' => [
        'ApplicationId' => '<string>',
        'CreationDate' => '<string>',
        'Enabled' => true || false,
        'HasCredential' => true || false,
        'Id' => '<string>',
        'IsArchived' => true || false,
        'LastModifiedBy' => '<string>',
        'LastModifiedDate' => '<string>',
        'Platform' => '<string>',
        'Version' => <integer>,
    ],
]

Result Details

Members

ADMChannelResponse

: Required: Yes
: Type: ADMChannelResponse structure

Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetApnsChannel

$result = $client->getApnsChannel([/* ... */]);
$promise = $client->getApnsChannelAsync([/* ... */]);

Retrieves information about the status and settings of the APNs channel for an application.

Parameter Syntax

$result = $client->getApnsChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
    ],
]

Result Details

Members

APNSChannelResponse

: Required: Yes
: Type: APNSChannelResponse structure

Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetApnsSandboxChannel

$result = $client->getApnsSandboxChannel([/* ... */]);
$promise = $client->getApnsSandboxChannelAsync([/* ... */]);

Retrieves information about the status and settings of the APNs sandbox channel for an application.

Parameter Syntax

$result = $client->getApnsSandboxChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
    ],
]

Result Details

Members

APNSSandboxChannelResponse

: Required: Yes
: Type: APNSSandboxChannelResponse structure

Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetApnsVoipChannel

$result = $client->getApnsVoipChannel([/* ... */]);
$promise = $client->getApnsVoipChannelAsync([/* ... */]);

Retrieves information about the status and settings of the APNs VoIP channel for an application.

Parameter Syntax

$result = $client->getApnsVoipChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
    ],
]

Result Details

Members

APNSVoipChannelResponse

: Required: Yes
: Type: APNSVoipChannelResponse structure

Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetApnsVoipSandboxChannel

$result = $client->getApnsVoipSandboxChannel([/* ... */]);
$promise = $client->getApnsVoipSandboxChannelAsync([/* ... */]);

Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.

Parameter Syntax

$result = $client->getApnsVoipSandboxChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
    ],
]

Result Details

Members

APNSVoipSandboxChannelResponse

: Required: Yes
: Type: APNSVoipSandboxChannelResponse structure

Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetApp

$result = $client->getApp([/* ... */]);
$promise = $client->getAppAsync([/* ... */]);

Retrieves information about an application.

Parameter Syntax

$result = $client->getApp([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result Syntax

[
    'ApplicationResponse' => [
        'Arn' => '<string>',
        'CreationDate' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

ApplicationResponse

: Required: Yes
: Type: ApplicationResponse structure

Provides information about an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetApplicationDateRangeKpi

$result = $client->getApplicationDateRangeKpi([/* ... */]);
$promise = $client->getApplicationDateRangeKpiAsync([/* ... */]);

Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.

Parameter Syntax

$result = $client->getApplicationDateRangeKpi([
    'ApplicationId' => '<string>', // REQUIRED
    'EndTime' => <integer || string || DateTime>,
    'KpiName' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'PageSize' => '<string>',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

EndTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

KpiName

: Required: Yes
: Type: string

NextToken

: Type: string

PageSize

: Type: string

StartTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Result Syntax

[
    'ApplicationDateRangeKpiResponse' => [
        'ApplicationId' => '<string>',
        'EndTime' => <DateTime>,
        'KpiName' => '<string>',
        'KpiResult' => [
            'Rows' => [
                [
                    'GroupedBys' => [
                        [
                            'Key' => '<string>',
                            'Type' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'Values' => [
                        [
                            'Key' => '<string>',
                            'Type' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'NextToken' => '<string>',
        'StartTime' => <DateTime>,
    ],
]

Result Details

Members

ApplicationDateRangeKpiResponse

: Required: Yes
: Type: ApplicationDateRangeKpiResponse structure

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.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetApplicationSettings

$result = $client->getApplicationSettings([/* ... */]);
$promise = $client->getApplicationSettingsAsync([/* ... */]);

Retrieves information about the settings for an application.

Parameter Syntax

$result = $client->getApplicationSettings([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result Syntax

[
    'ApplicationSettingsResource' => [
        'ApplicationId' => '<string>',
        'CampaignHook' => [
            'LambdaFunctionName' => '<string>',
            'Mode' => 'DELIVERY|FILTER',
            'WebUrl' => '<string>',
        ],
        'JourneyLimits' => [
            'DailyCap' => <integer>,
            'TimeframeCap' => [
                'Cap' => <integer>,
                'Days' => <integer>,
            ],
            'TotalCap' => <integer>,
        ],
        'LastModifiedDate' => '<string>',
        'Limits' => [
            'Daily' => <integer>,
            'MaximumDuration' => <integer>,
            'MessagesPerSecond' => <integer>,
            'Session' => <integer>,
            'Total' => <integer>,
        ],
        'QuietTime' => [
            'End' => '<string>',
            'Start' => '<string>',
        ],
    ],
]

Result Details

Members

ApplicationSettingsResource

: Required: Yes
: Type: ApplicationSettingsResource structure

Provides information about an application, including the default settings for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetApps

$result = $client->getApps([/* ... */]);
$promise = $client->getAppsAsync([/* ... */]);

Retrieves information about all the applications that are associated with your Amazon Pinpoint account.

Parameter Syntax

$result = $client->getApps([
    'PageSize' => '<string>',
    'Token' => '<string>',
]);

Parameter Details

Members

PageSize

: Type: string

Token

: Type: string

Result Syntax

[
    'ApplicationsResponse' => [
        'Item' => [
            [
                'Arn' => '<string>',
                'CreationDate' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
                'tags' => ['<string>', ...],
            ],
            // ...
        ],
        'NextToken' => '<string>',
    ],
]

Result Details

Members

ApplicationsResponse

: Required: Yes
: Type: ApplicationsResponse structure

Provides information about all of your applications.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetBaiduChannel

$result = $client->getBaiduChannel([/* ... */]);
$promise = $client->getBaiduChannelAsync([/* ... */]);

Retrieves information about the status and settings of the Baidu channel for an application.

Parameter Syntax

$result = $client->getBaiduChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
    ],
]

Result Details

Members

BaiduChannelResponse

: Required: Yes
: Type: BaiduChannelResponse structure

Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetCampaign

$result = $client->getCampaign([/* ... */]);
$promise = $client->getCampaignAsync([/* ... */]);

Retrieves information about the status, configuration, and other settings for a campaign.

Parameter Syntax

$result = $client->getCampaign([
    'ApplicationId' => '<string>', // REQUIRED
    'CampaignId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

CampaignId

: Required: Yes
: Type: string

Result Syntax

[
    'CampaignResponse' => [
        'AdditionalTreatments' => [
            [
                'CustomDeliveryConfiguration' => [
                    'DeliveryUri' => '<string>',
                    'EndpointTypes' => ['<string>', ...],
                ],
                '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<string>',
                    ],
                    'EmailMessage' => [
                        'Body' => '<string>',
                        'FromAddress' => '<string>',
                        'Headers' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<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' => <integer>,
                                        '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' => <integer>,
                                        '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>', ...],
                        'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
                    ],
                    'SMSMessage' => [
                        'Body' => '<string>',
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                ],
                'Schedule' => [
                    'EndTime' => '<string>',
                    'EventFilter' => [
                        'Dimensions' => [
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'EventType' => [
                                'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                'Values' => ['<string>', ...],
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>',
                                    'Value' => <float>,
                                ],
                                // ...
                            ],
                        ],
                        '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' => <integer>,
                'State' => [
                    'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
                ],
                'TemplateConfiguration' => [
                    'EmailTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                    'InAppTemplate' => [
                        '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' => ['<string>', ...],
        ],
        'DefaultState' => [
            'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
        ],
        'Description' => '<string>',
        'HoldoutPercent' => <integer>,
        'Hook' => [
            'LambdaFunctionName' => '<string>',
            'Mode' => 'DELIVERY|FILTER',
            'WebUrl' => '<string>',
        ],
        'Id' => '<string>',
        'IsPaused' => true || false,
        'LastModifiedDate' => '<string>',
        'Limits' => [
            'Daily' => <integer>,
            'MaximumDuration' => <integer>,
            'MessagesPerSecond' => <integer>,
            'Session' => <integer>,
            'Total' => <integer>,
        ],
        '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' => <integer>,
                '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' => <integer>,
                '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' => <integer>,
                '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' => <integer>,
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'EmailMessage' => [
                'Body' => '<string>',
                'FromAddress' => '<string>',
                'Headers' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<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' => <integer>,
                'Title' => '<string>',
                'Url' => '<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' => <integer>,
                                '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' => <integer>,
                                '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>', ...],
                'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
            ],
            'SMSMessage' => [
                'Body' => '<string>',
                'EntityId' => '<string>',
                'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                'OriginationNumber' => '<string>',
                'SenderId' => '<string>',
                'TemplateId' => '<string>',
            ],
        ],
        'Name' => '<string>',
        'Priority' => <integer>,
        'Schedule' => [
            'EndTime' => '<string>',
            'EventFilter' => [
                'Dimensions' => [
                    'Attributes' => [
                        '<__string>' => [
                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                            'Values' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'EventType' => [
                        'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                        'Values' => ['<string>', ...],
                    ],
                    'Metrics' => [
                        '<__string>' => [
                            'ComparisonOperator' => '<string>',
                            'Value' => <float>,
                        ],
                        // ...
                    ],
                ],
                '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' => <integer>,
        'State' => [
            'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
        ],
        'TemplateConfiguration' => [
            'EmailTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'InAppTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'PushTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'SMSTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'VoiceTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
        ],
        'TreatmentDescription' => '<string>',
        'TreatmentName' => '<string>',
        'Version' => <integer>,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

CampaignResponse

: Required: Yes
: Type: CampaignResponse structure

Provides information about the status, configuration, and other settings for a campaign.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetCampaignActivities

$result = $client->getCampaignActivities([/* ... */]);
$promise = $client->getCampaignActivitiesAsync([/* ... */]);

Retrieves information about all the activities for a campaign.

Parameter Syntax

$result = $client->getCampaignActivities([
    'ApplicationId' => '<string>', // REQUIRED
    'CampaignId' => '<string>', // REQUIRED
    'PageSize' => '<string>',
    'Token' => '<string>',
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

CampaignId

: Required: Yes
: Type: string

PageSize

: Type: string

Token

: Type: string

Result Syntax

[
    'ActivitiesResponse' => [
        'Item' => [
            [
                'ApplicationId' => '<string>',
                'CampaignId' => '<string>',
                'End' => '<string>',
                'ExecutionMetrics' => ['<string>', ...],
                'Id' => '<string>',
                'Result' => '<string>',
                'ScheduledStart' => '<string>',
                'Start' => '<string>',
                'State' => '<string>',
                'SuccessfulEndpointCount' => <integer>,
                'TimezonesCompletedCount' => <integer>,
                'TimezonesTotalCount' => <integer>,
                'TotalEndpointCount' => <integer>,
                'TreatmentId' => '<string>',
            ],
            // ...
        ],
        'NextToken' => '<string>',
    ],
]

Result Details

Members

ActivitiesResponse

: Required: Yes
: Type: ActivitiesResponse structure

Provides information about the activities that were performed by a campaign.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetCampaignDateRangeKpi

$result = $client->getCampaignDateRangeKpi([/* ... */]);
$promise = $client->getCampaignDateRangeKpiAsync([/* ... */]);

Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.

Parameter Syntax

$result = $client->getCampaignDateRangeKpi([
    'ApplicationId' => '<string>', // REQUIRED
    'CampaignId' => '<string>', // REQUIRED
    'EndTime' => <integer || string || DateTime>,
    'KpiName' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'PageSize' => '<string>',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

CampaignId

: Required: Yes
: Type: string

EndTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

KpiName

: Required: Yes
: Type: string

NextToken

: Type: string

PageSize

: Type: string

StartTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Result Syntax

[
    'CampaignDateRangeKpiResponse' => [
        'ApplicationId' => '<string>',
        'CampaignId' => '<string>',
        'EndTime' => <DateTime>,
        'KpiName' => '<string>',
        'KpiResult' => [
            'Rows' => [
                [
                    'GroupedBys' => [
                        [
                            'Key' => '<string>',
                            'Type' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'Values' => [
                        [
                            'Key' => '<string>',
                            'Type' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'NextToken' => '<string>',
        'StartTime' => <DateTime>,
    ],
]

Result Details

Members

CampaignDateRangeKpiResponse

: Required: Yes
: Type: CampaignDateRangeKpiResponse structure

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.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetCampaignVersion

$result = $client->getCampaignVersion([/* ... */]);
$promise = $client->getCampaignVersionAsync([/* ... */]);

Retrieves information about the status, configuration, and other settings for a specific version of a campaign.

Parameter Syntax

$result = $client->getCampaignVersion([
    'ApplicationId' => '<string>', // REQUIRED
    'CampaignId' => '<string>', // REQUIRED
    'Version' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

CampaignId

: Required: Yes
: Type: string

Version

: Required: Yes
: Type: string

Result Syntax

[
    'CampaignResponse' => [
        'AdditionalTreatments' => [
            [
                'CustomDeliveryConfiguration' => [
                    'DeliveryUri' => '<string>',
                    'EndpointTypes' => ['<string>', ...],
                ],
                '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<string>',
                    ],
                    'EmailMessage' => [
                        'Body' => '<string>',
                        'FromAddress' => '<string>',
                        'Headers' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<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' => <integer>,
                                        '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' => <integer>,
                                        '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>', ...],
                        'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
                    ],
                    'SMSMessage' => [
                        'Body' => '<string>',
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                ],
                'Schedule' => [
                    'EndTime' => '<string>',
                    'EventFilter' => [
                        'Dimensions' => [
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'EventType' => [
                                'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                'Values' => ['<string>', ...],
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>',
                                    'Value' => <float>,
                                ],
                                // ...
                            ],
                        ],
                        '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' => <integer>,
                'State' => [
                    'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
                ],
                'TemplateConfiguration' => [
                    'EmailTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                    'InAppTemplate' => [
                        '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' => ['<string>', ...],
        ],
        'DefaultState' => [
            'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
        ],
        'Description' => '<string>',
        'HoldoutPercent' => <integer>,
        'Hook' => [
            'LambdaFunctionName' => '<string>',
            'Mode' => 'DELIVERY|FILTER',
            'WebUrl' => '<string>',
        ],
        'Id' => '<string>',
        'IsPaused' => true || false,
        'LastModifiedDate' => '<string>',
        'Limits' => [
            'Daily' => <integer>,
            'MaximumDuration' => <integer>,
            'MessagesPerSecond' => <integer>,
            'Session' => <integer>,
            'Total' => <integer>,
        ],
        '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' => <integer>,
                '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' => <integer>,
                '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' => <integer>,
                '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' => <integer>,
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'EmailMessage' => [
                'Body' => '<string>',
                'FromAddress' => '<string>',
                'Headers' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<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' => <integer>,
                'Title' => '<string>',
                'Url' => '<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' => <integer>,
                                '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' => <integer>,
                                '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>', ...],
                'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
            ],
            'SMSMessage' => [
                'Body' => '<string>',
                'EntityId' => '<string>',
                'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                'OriginationNumber' => '<string>',
                'SenderId' => '<string>',
                'TemplateId' => '<string>',
            ],
        ],
        'Name' => '<string>',
        'Priority' => <integer>,
        'Schedule' => [
            'EndTime' => '<string>',
            'EventFilter' => [
                'Dimensions' => [
                    'Attributes' => [
                        '<__string>' => [
                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                            'Values' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'EventType' => [
                        'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                        'Values' => ['<string>', ...],
                    ],
                    'Metrics' => [
                        '<__string>' => [
                            'ComparisonOperator' => '<string>',
                            'Value' => <float>,
                        ],
                        // ...
                    ],
                ],
                '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' => <integer>,
        'State' => [
            'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
        ],
        'TemplateConfiguration' => [
            'EmailTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'InAppTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'PushTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'SMSTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'VoiceTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
        ],
        'TreatmentDescription' => '<string>',
        'TreatmentName' => '<string>',
        'Version' => <integer>,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

CampaignResponse

: Required: Yes
: Type: CampaignResponse structure

Provides information about the status, configuration, and other settings for a campaign.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetCampaignVersions

$result = $client->getCampaignVersions([/* ... */]);
$promise = $client->getCampaignVersionsAsync([/* ... */]);

Retrieves information about the status, configuration, and other settings for all versions of a campaign.

Parameter Syntax

$result = $client->getCampaignVersions([
    'ApplicationId' => '<string>', // REQUIRED
    'CampaignId' => '<string>', // REQUIRED
    'PageSize' => '<string>',
    'Token' => '<string>',
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

CampaignId

: Required: Yes
: Type: string

PageSize

: Type: string

Token

: Type: string

Result Syntax

[
    'CampaignsResponse' => [
        'Item' => [
            [
                'AdditionalTreatments' => [
                    [
                        'CustomDeliveryConfiguration' => [
                            'DeliveryUri' => '<string>',
                            'EndpointTypes' => ['<string>', ...],
                        ],
                        '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' => <integer>,
                                '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' => <integer>,
                                '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' => <integer>,
                                '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' => <integer>,
                                'Title' => '<string>',
                                'Url' => '<string>',
                            ],
                            'EmailMessage' => [
                                'Body' => '<string>',
                                'FromAddress' => '<string>',
                                'Headers' => [
                                    [
                                        'Name' => '<string>',
                                        'Value' => '<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' => <integer>,
                                'Title' => '<string>',
                                'Url' => '<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' => <integer>,
                                                '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' => <integer>,
                                                '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>', ...],
                                'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
                            ],
                            'SMSMessage' => [
                                'Body' => '<string>',
                                'EntityId' => '<string>',
                                'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                                'OriginationNumber' => '<string>',
                                'SenderId' => '<string>',
                                'TemplateId' => '<string>',
                            ],
                        ],
                        'Schedule' => [
                            'EndTime' => '<string>',
                            'EventFilter' => [
                                'Dimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                    'EventType' => [
                                        'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                        'Values' => ['<string>', ...],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>',
                                            'Value' => <float>,
                                        ],
                                        // ...
                                    ],
                                ],
                                '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' => <integer>,
                        'State' => [
                            'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
                        ],
                        'TemplateConfiguration' => [
                            'EmailTemplate' => [
                                'Name' => '<string>',
                                'Version' => '<string>',
                            ],
                            'InAppTemplate' => [
                                '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' => ['<string>', ...],
                ],
                'DefaultState' => [
                    'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
                ],
                'Description' => '<string>',
                'HoldoutPercent' => <integer>,
                'Hook' => [
                    'LambdaFunctionName' => '<string>',
                    'Mode' => 'DELIVERY|FILTER',
                    'WebUrl' => '<string>',
                ],
                'Id' => '<string>',
                'IsPaused' => true || false,
                'LastModifiedDate' => '<string>',
                'Limits' => [
                    'Daily' => <integer>,
                    'MaximumDuration' => <integer>,
                    'MessagesPerSecond' => <integer>,
                    'Session' => <integer>,
                    'Total' => <integer>,
                ],
                '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<string>',
                    ],
                    'EmailMessage' => [
                        'Body' => '<string>',
                        'FromAddress' => '<string>',
                        'Headers' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<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' => <integer>,
                                        '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' => <integer>,
                                        '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>', ...],
                        'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
                    ],
                    'SMSMessage' => [
                        'Body' => '<string>',
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                ],
                'Name' => '<string>',
                'Priority' => <integer>,
                'Schedule' => [
                    'EndTime' => '<string>',
                    'EventFilter' => [
                        'Dimensions' => [
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'EventType' => [
                                'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                'Values' => ['<string>', ...],
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>',
                                    'Value' => <float>,
                                ],
                                // ...
                            ],
                        ],
                        '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' => <integer>,
                'State' => [
                    'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
                ],
                'TemplateConfiguration' => [
                    'EmailTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                    'InAppTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                    'PushTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                    'SMSTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                    'VoiceTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                ],
                'TreatmentDescription' => '<string>',
                'TreatmentName' => '<string>',
                'Version' => <integer>,
                'tags' => ['<string>', ...],
            ],
            // ...
        ],
        'NextToken' => '<string>',
    ],
]

Result Details

Members

CampaignsResponse

: Required: Yes
: Type: CampaignsResponse structure

Provides information about the configuration and other settings for all the campaigns that are associated with an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetCampaigns

$result = $client->getCampaigns([/* ... */]);
$promise = $client->getCampaignsAsync([/* ... */]);

Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.

Parameter Syntax

$result = $client->getCampaigns([
    'ApplicationId' => '<string>', // REQUIRED
    'PageSize' => '<string>',
    'Token' => '<string>',
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

PageSize

: Type: string

Token

: Type: string

Result Syntax

[
    'CampaignsResponse' => [
        'Item' => [
            [
                'AdditionalTreatments' => [
                    [
                        'CustomDeliveryConfiguration' => [
                            'DeliveryUri' => '<string>',
                            'EndpointTypes' => ['<string>', ...],
                        ],
                        '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' => <integer>,
                                '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' => <integer>,
                                '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' => <integer>,
                                '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' => <integer>,
                                'Title' => '<string>',
                                'Url' => '<string>',
                            ],
                            'EmailMessage' => [
                                'Body' => '<string>',
                                'FromAddress' => '<string>',
                                'Headers' => [
                                    [
                                        'Name' => '<string>',
                                        'Value' => '<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' => <integer>,
                                'Title' => '<string>',
                                'Url' => '<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' => <integer>,
                                                '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' => <integer>,
                                                '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>', ...],
                                'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
                            ],
                            'SMSMessage' => [
                                'Body' => '<string>',
                                'EntityId' => '<string>',
                                'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                                'OriginationNumber' => '<string>',
                                'SenderId' => '<string>',
                                'TemplateId' => '<string>',
                            ],
                        ],
                        'Schedule' => [
                            'EndTime' => '<string>',
                            'EventFilter' => [
                                'Dimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                    'EventType' => [
                                        'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                        'Values' => ['<string>', ...],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>',
                                            'Value' => <float>,
                                        ],
                                        // ...
                                    ],
                                ],
                                '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' => <integer>,
                        'State' => [
                            'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
                        ],
                        'TemplateConfiguration' => [
                            'EmailTemplate' => [
                                'Name' => '<string>',
                                'Version' => '<string>',
                            ],
                            'InAppTemplate' => [
                                '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' => ['<string>', ...],
                ],
                'DefaultState' => [
                    'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
                ],
                'Description' => '<string>',
                'HoldoutPercent' => <integer>,
                'Hook' => [
                    'LambdaFunctionName' => '<string>',
                    'Mode' => 'DELIVERY|FILTER',
                    'WebUrl' => '<string>',
                ],
                'Id' => '<string>',
                'IsPaused' => true || false,
                'LastModifiedDate' => '<string>',
                'Limits' => [
                    'Daily' => <integer>,
                    'MaximumDuration' => <integer>,
                    'MessagesPerSecond' => <integer>,
                    'Session' => <integer>,
                    'Total' => <integer>,
                ],
                '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<string>',
                    ],
                    'EmailMessage' => [
                        'Body' => '<string>',
                        'FromAddress' => '<string>',
                        'Headers' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<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' => <integer>,
                                        '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' => <integer>,
                                        '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>', ...],
                        'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
                    ],
                    'SMSMessage' => [
                        'Body' => '<string>',
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                ],
                'Name' => '<string>',
                'Priority' => <integer>,
                'Schedule' => [
                    'EndTime' => '<string>',
                    'EventFilter' => [
                        'Dimensions' => [
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'EventType' => [
                                'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                'Values' => ['<string>', ...],
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>',
                                    'Value' => <float>,
                                ],
                                // ...
                            ],
                        ],
                        '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' => <integer>,
                'State' => [
                    'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
                ],
                'TemplateConfiguration' => [
                    'EmailTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                    'InAppTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                    'PushTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                    'SMSTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                    'VoiceTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                ],
                'TreatmentDescription' => '<string>',
                'TreatmentName' => '<string>',
                'Version' => <integer>,
                'tags' => ['<string>', ...],
            ],
            // ...
        ],
        'NextToken' => '<string>',
    ],
]

Result Details

Members

CampaignsResponse

: Required: Yes
: Type: CampaignsResponse structure

Provides information about the configuration and other settings for all the campaigns that are associated with an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetChannels

$result = $client->getChannels([/* ... */]);
$promise = $client->getChannelsAsync([/* ... */]);

Retrieves information about the history and status of each channel for an application.

Parameter Syntax

$result = $client->getChannels([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result Syntax

[
    'ChannelsResponse' => [
        'Channels' => [
            '<__string>' => [
                'ApplicationId' => '<string>',
                'CreationDate' => '<string>',
                'Enabled' => true || false,
                'HasCredential' => true || false,
                'Id' => '<string>',
                'IsArchived' => true || false,
                'LastModifiedBy' => '<string>',
                'LastModifiedDate' => '<string>',
                'Version' => <integer>,
            ],
            // ...
        ],
    ],
]

Result Details

Members

ChannelsResponse

: Required: Yes
: Type: ChannelsResponse structure

Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetEmailChannel

$result = $client->getEmailChannel([/* ... */]);
$promise = $client->getEmailChannelAsync([/* ... */]);

Retrieves information about the status and settings of the email channel for an application.

Parameter Syntax

$result = $client->getEmailChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
        'OrchestrationSendingRoleArn' => '<string>',
        'Platform' => '<string>',
        'RoleArn' => '<string>',
        'Version' => <integer>,
    ],
]

Result Details

Members

EmailChannelResponse

: Required: Yes
: Type: EmailChannelResponse structure

Provides information about the status and settings of the email channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetEmailTemplate

$result = $client->getEmailTemplate([/* ... */]);
$promise = $client->getEmailTemplateAsync([/* ... */]);

Retrieves the content and settings of a message template for messages that are sent through the email channel.

Parameter Syntax

$result = $client->getEmailTemplate([
    'TemplateName' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members

TemplateName

: Required: Yes
: Type: string

Version

: Type: string

Result Syntax

[
    'EmailTemplateResponse' => [
        'Arn' => '<string>',
        'CreationDate' => '<string>',
        'DefaultSubstitutions' => '<string>',
        'Headers' => [
            [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'HtmlPart' => '<string>',
        'LastModifiedDate' => '<string>',
        'RecommenderId' => '<string>',
        'Subject' => '<string>',
        'TemplateDescription' => '<string>',
        'TemplateName' => '<string>',
        'TemplateType' => 'EMAIL|SMS|VOICE|PUSH|INAPP',
        'TextPart' => '<string>',
        'Version' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

EmailTemplateResponse

: Required: Yes
: Type: EmailTemplateResponse structure

Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetEventStream

$result = $client->getEventStream([/* ... */]);
$promise = $client->getEventStreamAsync([/* ... */]);

Retrieves information about the event stream settings for an application.

Parameter Syntax

$result = $client->getEventStream([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result Syntax

[
    'EventStream' => [
        'ApplicationId' => '<string>',
        'DestinationStreamArn' => '<string>',
        'ExternalId' => '<string>',
        'LastModifiedDate' => '<string>',
        'LastUpdatedBy' => '<string>',
        'RoleArn' => '<string>',
    ],
]

Result Details

Members

EventStream

: Required: Yes
: Type: EventStream structure

Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetExportJob

$result = $client->getExportJob([/* ... */]);
$promise = $client->getExportJobAsync([/* ... */]);

Retrieves information about the status and settings of a specific export job for an application.

Parameter Syntax

$result = $client->getExportJob([
    'ApplicationId' => '<string>', // REQUIRED
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

JobId

: Required: Yes
: Type: string

Result Syntax

[
    'ExportJobResponse' => [
        'ApplicationId' => '<string>',
        'CompletedPieces' => <integer>,
        'CompletionDate' => '<string>',
        'CreationDate' => '<string>',
        'Definition' => [
            'RoleArn' => '<string>',
            'S3UrlPrefix' => '<string>',
            'SegmentId' => '<string>',
            'SegmentVersion' => <integer>,
        ],
        'FailedPieces' => <integer>,
        'Failures' => ['<string>', ...],
        'Id' => '<string>',
        'JobStatus' => 'CREATED|PREPARING_FOR_INITIALIZATION|INITIALIZING|PROCESSING|PENDING_JOB|COMPLETING|COMPLETED|FAILING|FAILED',
        'TotalFailures' => <integer>,
        'TotalPieces' => <integer>,
        'TotalProcessed' => <integer>,
        'Type' => '<string>',
    ],
]

Result Details

Members

ExportJobResponse

: Required: Yes
: Type: ExportJobResponse structure

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetExportJobs

$result = $client->getExportJobs([/* ... */]);
$promise = $client->getExportJobsAsync([/* ... */]);

Retrieves information about the status and settings of all the export jobs for an application.

Parameter Syntax

$result = $client->getExportJobs([
    'ApplicationId' => '<string>', // REQUIRED
    'PageSize' => '<string>',
    'Token' => '<string>',
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

PageSize

: Type: string

Token

: Type: string

Result Syntax

[
    'ExportJobsResponse' => [
        'Item' => [
            [
                'ApplicationId' => '<string>',
                'CompletedPieces' => <integer>,
                'CompletionDate' => '<string>',
                'CreationDate' => '<string>',
                'Definition' => [
                    'RoleArn' => '<string>',
                    'S3UrlPrefix' => '<string>',
                    'SegmentId' => '<string>',
                    'SegmentVersion' => <integer>,
                ],
                'FailedPieces' => <integer>,
                'Failures' => ['<string>', ...],
                'Id' => '<string>',
                'JobStatus' => 'CREATED|PREPARING_FOR_INITIALIZATION|INITIALIZING|PROCESSING|PENDING_JOB|COMPLETING|COMPLETED|FAILING|FAILED',
                'TotalFailures' => <integer>,
                'TotalPieces' => <integer>,
                'TotalProcessed' => <integer>,
                'Type' => '<string>',
            ],
            // ...
        ],
        'NextToken' => '<string>',
    ],
]

Result Details

Members

ExportJobsResponse

: Required: Yes
: Type: ExportJobsResponse structure

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.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetGcmChannel

$result = $client->getGcmChannel([/* ... */]);
$promise = $client->getGcmChannelAsync([/* ... */]);

Retrieves information about the status and settings of the GCM channel for an application.

Parameter Syntax

$result = $client->getGcmChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result Syntax

[
    'GCMChannelResponse' => [
        'ApplicationId' => '<string>',
        'CreationDate' => '<string>',
        'Credential' => '<string>',
        'DefaultAuthenticationMethod' => '<string>',
        'Enabled' => true || false,
        'HasCredential' => true || false,
        'HasFcmServiceCredentials' => true || false,
        'Id' => '<string>',
        'IsArchived' => true || false,
        'LastModifiedBy' => '<string>',
        'LastModifiedDate' => '<string>',
        'Platform' => '<string>',
        'Version' => <integer>,
    ],
]

Result Details

Members

GCMChannelResponse

: Required: Yes
: Type: GCMChannelResponse structure

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetImportJob

$result = $client->getImportJob([/* ... */]);
$promise = $client->getImportJobAsync([/* ... */]);

Retrieves information about the status and settings of a specific import job for an application.

Parameter Syntax

$result = $client->getImportJob([
    'ApplicationId' => '<string>', // REQUIRED
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

JobId

: Required: Yes
: Type: string

Result Syntax

[
    'ImportJobResponse' => [
        'ApplicationId' => '<string>',
        'CompletedPieces' => <integer>,
        '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' => <integer>,
        'Failures' => ['<string>', ...],
        'Id' => '<string>',
        'JobStatus' => 'CREATED|PREPARING_FOR_INITIALIZATION|INITIALIZING|PROCESSING|PENDING_JOB|COMPLETING|COMPLETED|FAILING|FAILED',
        'TotalFailures' => <integer>,
        'TotalPieces' => <integer>,
        'TotalProcessed' => <integer>,
        'Type' => '<string>',
    ],
]

Result Details

Members

ImportJobResponse

: Required: Yes
: Type: ImportJobResponse structure

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetImportJobs

$result = $client->getImportJobs([/* ... */]);
$promise = $client->getImportJobsAsync([/* ... */]);

Retrieves information about the status and settings of all the import jobs for an application.

Parameter Syntax

$result = $client->getImportJobs([
    'ApplicationId' => '<string>', // REQUIRED
    'PageSize' => '<string>',
    'Token' => '<string>',
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

PageSize

: Type: string

Token

: Type: string

Result Syntax

[
    'ImportJobsResponse' => [
        'Item' => [
            [
                'ApplicationId' => '<string>',
                'CompletedPieces' => <integer>,
                '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' => <integer>,
                'Failures' => ['<string>', ...],
                'Id' => '<string>',
                'JobStatus' => 'CREATED|PREPARING_FOR_INITIALIZATION|INITIALIZING|PROCESSING|PENDING_JOB|COMPLETING|COMPLETED|FAILING|FAILED',
                'TotalFailures' => <integer>,
                'TotalPieces' => <integer>,
                'TotalProcessed' => <integer>,
                'Type' => '<string>',
            ],
            // ...
        ],
        'NextToken' => '<string>',
    ],
]

Result Details

Members

ImportJobsResponse

: Required: Yes
: Type: ImportJobsResponse structure

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.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetInAppMessages

$result = $client->getInAppMessages([/* ... */]);
$promise = $client->getInAppMessagesAsync([/* ... */]);

Retrieves the in-app messages targeted for the provided endpoint ID.

Parameter Syntax

$result = $client->getInAppMessages([
    'ApplicationId' => '<string>', // REQUIRED
    'EndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

EndpointId

: Required: Yes
: Type: string

Result Syntax

[
    'InAppMessagesResponse' => [
        'InAppMessageCampaigns' => [
            [
                'CampaignId' => '<string>',
                'DailyCap' => <integer>,
                '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' => <integer>,
                                    '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' => <integer>,
                                    '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>', ...],
                    'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
                ],
                'Priority' => <integer>,
                'Schedule' => [
                    'EndDate' => '<string>',
                    'EventFilter' => [
                        'Dimensions' => [
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'EventType' => [
                                'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                'Values' => ['<string>', ...],
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>',
                                    'Value' => <float>,
                                ],
                                // ...
                            ],
                        ],
                        'FilterType' => 'SYSTEM|ENDPOINT',
                    ],
                    'QuietTime' => [
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                ],
                'SessionCap' => <integer>,
                'TotalCap' => <integer>,
                'TreatmentId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

InAppMessagesResponse

: Required: Yes
: Type: InAppMessagesResponse structure

Get in-app messages response object.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetInAppTemplate

$result = $client->getInAppTemplate([/* ... */]);
$promise = $client->getInAppTemplateAsync([/* ... */]);

Retrieves the content and settings of a message template for messages sent through the in-app channel.

Parameter Syntax

$result = $client->getInAppTemplate([
    'TemplateName' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members

TemplateName

: Required: Yes
: Type: string

Version

: Type: string

Result 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' => <integer>,
                        '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' => <integer>,
                        '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>', ...],
        'LastModifiedDate' => '<string>',
        'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
        'TemplateDescription' => '<string>',
        'TemplateName' => '<string>',
        'TemplateType' => 'EMAIL|SMS|VOICE|PUSH|INAPP',
        'Version' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

InAppTemplateResponse

: Required: Yes
: Type: InAppTemplateResponse structure

In-App Template Response.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetJourney

$result = $client->getJourney([/* ... */]);
$promise = $client->getJourneyAsync([/* ... */]);

Retrieves information about the status, configuration, and other settings for a journey.

Parameter Syntax

$result = $client->getJourney([
    'ApplicationId' => '<string>', // REQUIRED
    'JourneyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

JourneyId

: Required: Yes
: Type: string

Result Syntax

[
    'JourneyResponse' => [
        'Activities' => [
            '<__string>' => [
                'CUSTOM' => [
                    'DeliveryUri' => '<string>',
                    'EndpointTypes' => ['<string>', ...],
                    'MessageConfig' => [
                        'Data' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'ConditionalSplit' => [
                    'Condition' => [
                        'Conditions' => [
                            [
                                'EventCondition' => [
                                    'Dimensions' => [
                                        'Attributes' => [
                                            '<__string>' => [
                                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                'Values' => ['<string>', ...],
                                            ],
                                            // ...
                                        ],
                                        'EventType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...],
                                        ],
                                        'Metrics' => [
                                            '<__string>' => [
                                                'ComparisonOperator' => '<string>',
                                                'Value' => <float>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'MessageActivity' => '<string>',
                                ],
                                'SegmentCondition' => [
                                    'SegmentId' => '<string>',
                                ],
                                'SegmentDimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <float>,
                                                'Longitude' => <float>,
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>',
                                            'Value' => <float>,
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            // ...
                        ],
                        'Operator' => 'ALL|ANY',
                    ],
                    'EvaluationWaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                    'FalseActivity' => '<string>',
                    'TrueActivity' => '<string>',
                ],
                'ContactCenter' => [
                    'NextActivity' => '<string>',
                ],
                'Description' => '<string>',
                'EMAIL' => [
                    'MessageConfig' => [
                        'FromAddress' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'Holdout' => [
                    'NextActivity' => '<string>',
                    'Percentage' => <integer>,
                ],
                'MultiCondition' => [
                    'Branches' => [
                        [
                            'Condition' => [
                                'EventCondition' => [
                                    'Dimensions' => [
                                        'Attributes' => [
                                            '<__string>' => [
                                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                'Values' => ['<string>', ...],
                                            ],
                                            // ...
                                        ],
                                        'EventType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...],
                                        ],
                                        'Metrics' => [
                                            '<__string>' => [
                                                'ComparisonOperator' => '<string>',
                                                'Value' => <float>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'MessageActivity' => '<string>',
                                ],
                                'SegmentCondition' => [
                                    'SegmentId' => '<string>',
                                ],
                                'SegmentDimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <float>,
                                                'Longitude' => <float>,
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>',
                                            'Value' => <float>,
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'SMS' => [
                    'MessageConfig' => [
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'Wait' => [
                    'NextActivity' => '<string>',
                    'WaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'ApplicationId' => '<string>',
        'ClosedDays' => [
            'CUSTOM' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'EMAIL' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'PUSH' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'SMS' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'VOICE' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
        ],
        'CreationDate' => '<string>',
        'Id' => '<string>',
        'JourneyChannelSettings' => [
            'ConnectCampaignArn' => '<string>',
            'ConnectCampaignExecutionRoleArn' => '<string>',
        ],
        'LastModifiedDate' => '<string>',
        'Limits' => [
            'DailyCap' => <integer>,
            'EndpointReentryCap' => <integer>,
            'EndpointReentryInterval' => '<string>',
            'MessagesPerSecond' => <integer>,
            'TimeframeCap' => [
                'Cap' => <integer>,
                'Days' => <integer>,
            ],
            'TotalCap' => <integer>,
        ],
        'LocalTime' => true || false,
        'Name' => '<string>',
        'OpenHours' => [
            'CUSTOM' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'EMAIL' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'PUSH' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'SMS' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'VOICE' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
        ],
        'QuietTime' => [
            'End' => '<string>',
            'Start' => '<string>',
        ],
        'RefreshFrequency' => '<string>',
        'RefreshOnSegmentUpdate' => true || false,
        'Schedule' => [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
            'Timezone' => '<string>',
        ],
        'SendingSchedule' => true || false,
        'StartActivity' => '<string>',
        'StartCondition' => [
            'Description' => '<string>',
            'EventStartCondition' => [
                'EventFilter' => [
                    'Dimensions' => [
                        'Attributes' => [
                            '<__string>' => [
                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                'Values' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'EventType' => [
                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                            'Values' => ['<string>', ...],
                        ],
                        'Metrics' => [
                            '<__string>' => [
                                'ComparisonOperator' => '<string>',
                                'Value' => <float>,
                            ],
                            // ...
                        ],
                    ],
                    'FilterType' => 'SYSTEM|ENDPOINT',
                ],
                'SegmentId' => '<string>',
            ],
            'SegmentStartCondition' => [
                'SegmentId' => '<string>',
            ],
        ],
        'State' => 'DRAFT|ACTIVE|COMPLETED|CANCELLED|CLOSED|PAUSED',
        'TimezoneEstimationMethods' => ['<string>', ...],
        'WaitForQuietTime' => true || false,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

JourneyResponse

: Required: Yes
: Type: JourneyResponse structure

Provides information about the status, configuration, and other settings for a journey.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetJourneyDateRangeKpi

$result = $client->getJourneyDateRangeKpi([/* ... */]);
$promise = $client->getJourneyDateRangeKpiAsync([/* ... */]);

Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.

Parameter Syntax

$result = $client->getJourneyDateRangeKpi([
    'ApplicationId' => '<string>', // REQUIRED
    'EndTime' => <integer || string || DateTime>,
    'JourneyId' => '<string>', // REQUIRED
    'KpiName' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'PageSize' => '<string>',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

EndTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

JourneyId

: Required: Yes
: Type: string

KpiName

: Required: Yes
: Type: string

NextToken

: Type: string

PageSize

: Type: string

StartTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Result Syntax

[
    'JourneyDateRangeKpiResponse' => [
        'ApplicationId' => '<string>',
        'EndTime' => <DateTime>,
        'JourneyId' => '<string>',
        'KpiName' => '<string>',
        'KpiResult' => [
            'Rows' => [
                [
                    'GroupedBys' => [
                        [
                            'Key' => '<string>',
                            'Type' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'Values' => [
                        [
                            'Key' => '<string>',
                            'Type' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'NextToken' => '<string>',
        'StartTime' => <DateTime>,
    ],
]

Result Details

Members

JourneyDateRangeKpiResponse

: Required: Yes
: Type: JourneyDateRangeKpiResponse structure

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.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetJourneyExecutionActivityMetrics

$result = $client->getJourneyExecutionActivityMetrics([/* ... */]);
$promise = $client->getJourneyExecutionActivityMetricsAsync([/* ... */]);

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.

Parameter Syntax

$result = $client->getJourneyExecutionActivityMetrics([
    'ApplicationId' => '<string>', // REQUIRED
    'JourneyActivityId' => '<string>', // REQUIRED
    'JourneyId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'PageSize' => '<string>',
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

JourneyActivityId

: Required: Yes
: Type: string

JourneyId

: Required: Yes
: Type: string

NextToken

: Type: string

PageSize

: Type: string

Result Syntax

[
    'JourneyExecutionActivityMetricsResponse' => [
        'ActivityType' => '<string>',
        'ApplicationId' => '<string>',
        'JourneyActivityId' => '<string>',
        'JourneyId' => '<string>',
        'LastEvaluatedTime' => '<string>',
        'Metrics' => ['<string>', ...],
    ],
]

Result Details

Members

JourneyExecutionActivityMetricsResponse

: Required: Yes
: Type: JourneyExecutionActivityMetricsResponse structure

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.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetJourneyExecutionMetrics

$result = $client->getJourneyExecutionMetrics([/* ... */]);
$promise = $client->getJourneyExecutionMetricsAsync([/* ... */]);

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.

Parameter Syntax

$result = $client->getJourneyExecutionMetrics([
    'ApplicationId' => '<string>', // REQUIRED
    'JourneyId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'PageSize' => '<string>',
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

JourneyId

: Required: Yes
: Type: string

NextToken

: Type: string

PageSize

: Type: string

Result Syntax

[
    'JourneyExecutionMetricsResponse' => [
        'ApplicationId' => '<string>',
        'JourneyId' => '<string>',
        'LastEvaluatedTime' => '<string>',
        'Metrics' => ['<string>', ...],
    ],
]

Result Details

Members

JourneyExecutionMetricsResponse

: Required: Yes
: Type: JourneyExecutionMetricsResponse structure

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.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetJourneyRunExecutionActivityMetrics

$result = $client->getJourneyRunExecutionActivityMetrics([/* ... */]);
$promise = $client->getJourneyRunExecutionActivityMetricsAsync([/* ... */]);

Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.

Parameter Syntax

$result = $client->getJourneyRunExecutionActivityMetrics([
    'ApplicationId' => '<string>', // REQUIRED
    'JourneyActivityId' => '<string>', // REQUIRED
    'JourneyId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'PageSize' => '<string>',
    'RunId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

JourneyActivityId

: Required: Yes
: Type: string

JourneyId

: Required: Yes
: Type: string

NextToken

: Type: string

PageSize

: Type: string

RunId

: Required: Yes
: Type: string

Result Syntax

[
    'JourneyRunExecutionActivityMetricsResponse' => [
        'ActivityType' => '<string>',
        'ApplicationId' => '<string>',
        'JourneyActivityId' => '<string>',
        'JourneyId' => '<string>',
        'LastEvaluatedTime' => '<string>',
        'Metrics' => ['<string>', ...],
        'RunId' => '<string>',
    ],
]

Result Details

Members

JourneyRunExecutionActivityMetricsResponse

: Required: Yes
: Type: JourneyRunExecutionActivityMetricsResponse structure

Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity for a particular journey run, and provides information about that query.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

Examples

Example 1: To get the activity execution metrics for a journey run

The following example gets activity execution metrics for a single run of a journey.

$result = $client->getJourneyRunExecutionActivityMetrics([
    'ApplicationId' => '11111111112222222222333333333344',
    'JourneyId' => 'aaaaaaaaaabbbbbbbbbbccccccccccdd',
    'RunId' => '99999999998888888888777777777766',
    'JourneyActivityId' => 'AAAAAAAAAA',
]);

Result syntax:

[
    'JourneyRunExecutionActivityMetricsResponse' => [
        'ApplicationId' => '11111111112222222222333333333344',
        'JourneyId' => 'aaaaaaaaaabbbbbbbbbbccccccccccdd',
        'RunId' => '99999999998888888888777777777766',
        'JourneyActivityId' => 'AAAAAAAAAA',
        'ActivityType' => 'EMAIL',
        'LastEvaluatedTime' => '2000-01-01T00:00:05.000Z',
        'Metrics' => [
            'SUCCESS' => '1',
        ],
    ],
]

GetJourneyRunExecutionMetrics

$result = $client->getJourneyRunExecutionMetrics([/* ... */]);
$promise = $client->getJourneyRunExecutionMetricsAsync([/* ... */]);

Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.

Parameter Syntax

$result = $client->getJourneyRunExecutionMetrics([
    'ApplicationId' => '<string>', // REQUIRED
    'JourneyId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'PageSize' => '<string>',
    'RunId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

JourneyId

: Required: Yes
: Type: string

NextToken

: Type: string

PageSize

: Type: string

RunId

: Required: Yes
: Type: string

Result Syntax

[
    'JourneyRunExecutionMetricsResponse' => [
        'ApplicationId' => '<string>',
        'JourneyId' => '<string>',
        'LastEvaluatedTime' => '<string>',
        'Metrics' => ['<string>', ...],
        'RunId' => '<string>',
    ],
]

Result Details

Members

JourneyRunExecutionMetricsResponse

: Required: Yes
: Type: JourneyRunExecutionMetricsResponse structure

Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey run, and provides information about that query.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

Examples

Example 1: To get the execution metrics for a journey run

The following example gets execution metrics for a single run of a journey.

$result = $client->getJourneyRunExecutionMetrics([
    'ApplicationId' => '11111111112222222222333333333344',
    'JourneyId' => 'aaaaaaaaaabbbbbbbbbbccccccccccdd',
    'RunId' => '99999999998888888888777777777766',
]);

Result syntax:

[
    'JourneyRunExecutionMetricsResponse' => [
        'ApplicationId' => '11111111112222222222333333333344',
        'JourneyId' => 'aaaaaaaaaabbbbbbbbbbccccccccccdd',
        'RunId' => '99999999998888888888777777777766',
        'LastEvaluatedTime' => '2000-01-01T00:00:05.000Z',
        'Metrics' => [
            'ENDPOINT_PRODUCED' => '1',
            'ENDPOINT_ENTERED' => '1',
            'ENDPOINT_LEFT' => '1',
        ],
    ],
]

GetJourneyRuns

$result = $client->getJourneyRuns([/* ... */]);
$promise = $client->getJourneyRunsAsync([/* ... */]);

Provides information about the runs of a journey.

Parameter Syntax

$result = $client->getJourneyRuns([
    'ApplicationId' => '<string>', // REQUIRED
    'JourneyId' => '<string>', // REQUIRED
    'PageSize' => '<string>',
    'Token' => '<string>',
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

JourneyId

: Required: Yes
: Type: string

PageSize

: Type: string

Token

: Type: string

Result Syntax

[
    'JourneyRunsResponse' => [
        'Item' => [
            [
                'CreationTime' => '<string>',
                'LastUpdateTime' => '<string>',
                'RunId' => '<string>',
                'Status' => 'SCHEDULED|RUNNING|COMPLETED|CANCELLED',
            ],
            // ...
        ],
        'NextToken' => '<string>',
    ],
]

Result Details

Members

JourneyRunsResponse

: Required: Yes
: Type: JourneyRunsResponse structure

Provides information from all runs of a journey.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

Examples

Example 1: To get the runs of a journey

The following example gets the runs of a journey.

$result = $client->getJourneyRuns([
    'ApplicationId' => '11111111112222222222333333333344',
    'JourneyId' => 'aaaaaaaaaabbbbbbbbbbccccccccccdd',
]);

Result syntax:

[
    'JourneyRunsResponse' => [
        'Item' => [
            [
                'RunId' => '99999999998888888888777777777766',
                'CreationTime' => '2000-01-01T00:00:00.000Z',
                'LastUpdateTime' => '2000-01-01T00:00:05.000Z',
                'Status' => 'COMPLETED',
            ],
            [
                'RunId' => 'ffffffffffeeeeeeeeeeddddddddddcc',
                'CreationTime' => '2000-01-01T00:00:10.000Z',
                'LastUpdateTime' => '2000-01-01T00:00:10.000Z',
                'Status' => 'SCHEDULED',
            ],
        ],
    ],
]

GetPushTemplate

$result = $client->getPushTemplate([/* ... */]);
$promise = $client->getPushTemplateAsync([/* ... */]);

Retrieves the content and settings of a message template for messages that are sent through a push notification channel.

Parameter Syntax

$result = $client->getPushTemplate([
    'TemplateName' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members

TemplateName

: Required: Yes
: Type: string

Version

: Type: string

Result 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>',
        'TemplateDescription' => '<string>',
        'TemplateName' => '<string>',
        'TemplateType' => 'EMAIL|SMS|VOICE|PUSH|INAPP',
        'Version' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

PushNotificationTemplateResponse

: Required: Yes
: Type: PushNotificationTemplateResponse structure

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.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetRecommenderConfiguration

$result = $client->getRecommenderConfiguration([/* ... */]);
$promise = $client->getRecommenderConfigurationAsync([/* ... */]);

Retrieves information about an Amazon Pinpoint configuration for a recommender model.

Parameter Syntax

$result = $client->getRecommenderConfiguration([
    'RecommenderId' => '<string>', // REQUIRED
]);

Parameter Details

Members

RecommenderId

: Required: Yes
: Type: string

Result Syntax

[
    'RecommenderConfigurationResponse' => [
        'Attributes' => ['<string>', ...],
        'CreationDate' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'LastModifiedDate' => '<string>',
        'Name' => '<string>',
        'RecommendationProviderIdType' => '<string>',
        'RecommendationProviderRoleArn' => '<string>',
        'RecommendationProviderUri' => '<string>',
        'RecommendationTransformerUri' => '<string>',
        'RecommendationsDisplayName' => '<string>',
        'RecommendationsPerMessage' => <integer>,
    ],
]

Result Details

Members

RecommenderConfigurationResponse

: Required: Yes
: Type: RecommenderConfigurationResponse structure

Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetRecommenderConfigurations

$result = $client->getRecommenderConfigurations([/* ... */]);
$promise = $client->getRecommenderConfigurationsAsync([/* ... */]);

Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.

Parameter Syntax

$result = $client->getRecommenderConfigurations([
    'PageSize' => '<string>',
    'Token' => '<string>',
]);

Parameter Details

Members

PageSize

: Type: string

Token

: Type: string

Result Syntax

[
    'ListRecommenderConfigurationsResponse' => [
        'Item' => [
            [
                'Attributes' => ['<string>', ...],
                'CreationDate' => '<string>',
                'Description' => '<string>',
                'Id' => '<string>',
                'LastModifiedDate' => '<string>',
                'Name' => '<string>',
                'RecommendationProviderIdType' => '<string>',
                'RecommendationProviderRoleArn' => '<string>',
                'RecommendationProviderUri' => '<string>',
                'RecommendationTransformerUri' => '<string>',
                'RecommendationsDisplayName' => '<string>',
                'RecommendationsPerMessage' => <integer>,
            ],
            // ...
        ],
        'NextToken' => '<string>',
    ],
]

Result Details

Members

ListRecommenderConfigurationsResponse

: Required: Yes
: Type: ListRecommenderConfigurationsResponse structure

Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetSegment

$result = $client->getSegment([/* ... */]);
$promise = $client->getSegmentAsync([/* ... */]);

Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.

Parameter Syntax

$result = $client->getSegment([
    'ApplicationId' => '<string>', // REQUIRED
    'SegmentId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

SegmentId

: Required: Yes
: Type: string

Result Syntax

[
    'SegmentResponse' => [
        'ApplicationId' => '<string>',
        'Arn' => '<string>',
        'CreationDate' => '<string>',
        'Dimensions' => [
            'Attributes' => [
                '<__string>' => [
                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                    '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' => <float>,
                        'Longitude' => <float>,
                    ],
                    'RangeInKilometers' => <float>,
                ],
            ],
            'Metrics' => [
                '<__string>' => [
                    'ComparisonOperator' => '<string>',
                    'Value' => <float>,
                ],
                // ...
            ],
            'UserAttributes' => [
                '<__string>' => [
                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'Id' => '<string>',
        'ImportDefinition' => [
            'ChannelCounts' => [<integer>, ...],
            'ExternalId' => '<string>',
            'Format' => 'CSV|JSON',
            'RoleArn' => '<string>',
            'S3Url' => '<string>',
            'Size' => <integer>,
        ],
        'LastModifiedDate' => '<string>',
        'Name' => '<string>',
        'SegmentGroups' => [
            'Groups' => [
                [
                    'Dimensions' => [
                        [
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    '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' => <float>,
                                        'Longitude' => <float>,
                                    ],
                                    'RangeInKilometers' => <float>,
                                ],
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>',
                                    'Value' => <float>,
                                ],
                                // ...
                            ],
                            'UserAttributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'SourceSegments' => [
                        [
                            'Id' => '<string>',
                            'Version' => <integer>,
                        ],
                        // ...
                    ],
                    'SourceType' => 'ALL|ANY|NONE',
                    'Type' => 'ALL|ANY|NONE',
                ],
                // ...
            ],
            'Include' => 'ALL|ANY|NONE',
        ],
        'SegmentType' => 'DIMENSIONAL|IMPORT',
        'Version' => <integer>,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

SegmentResponse

: Required: Yes
: Type: SegmentResponse structure

Provides information about the configuration, dimension, and other settings for a segment.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetSegmentExportJobs

$result = $client->getSegmentExportJobs([/* ... */]);
$promise = $client->getSegmentExportJobsAsync([/* ... */]);

Retrieves information about the status and settings of the export jobs for a segment.

Parameter Syntax

$result = $client->getSegmentExportJobs([
    'ApplicationId' => '<string>', // REQUIRED
    'PageSize' => '<string>',
    'SegmentId' => '<string>', // REQUIRED
    'Token' => '<string>',
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

PageSize

: Type: string

SegmentId

: Required: Yes
: Type: string

Token

: Type: string

Result Syntax

[
    'ExportJobsResponse' => [
        'Item' => [
            [
                'ApplicationId' => '<string>',
                'CompletedPieces' => <integer>,
                'CompletionDate' => '<string>',
                'CreationDate' => '<string>',
                'Definition' => [
                    'RoleArn' => '<string>',
                    'S3UrlPrefix' => '<string>',
                    'SegmentId' => '<string>',
                    'SegmentVersion' => <integer>,
                ],
                'FailedPieces' => <integer>,
                'Failures' => ['<string>', ...],
                'Id' => '<string>',
                'JobStatus' => 'CREATED|PREPARING_FOR_INITIALIZATION|INITIALIZING|PROCESSING|PENDING_JOB|COMPLETING|COMPLETED|FAILING|FAILED',
                'TotalFailures' => <integer>,
                'TotalPieces' => <integer>,
                'TotalProcessed' => <integer>,
                'Type' => '<string>',
            ],
            // ...
        ],
        'NextToken' => '<string>',
    ],
]

Result Details

Members

ExportJobsResponse

: Required: Yes
: Type: ExportJobsResponse structure

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.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetSegmentImportJobs

$result = $client->getSegmentImportJobs([/* ... */]);
$promise = $client->getSegmentImportJobsAsync([/* ... */]);

Retrieves information about the status and settings of the import jobs for a segment.

Parameter Syntax

$result = $client->getSegmentImportJobs([
    'ApplicationId' => '<string>', // REQUIRED
    'PageSize' => '<string>',
    'SegmentId' => '<string>', // REQUIRED
    'Token' => '<string>',
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

PageSize

: Type: string

SegmentId

: Required: Yes
: Type: string

Token

: Type: string

Result Syntax

[
    'ImportJobsResponse' => [
        'Item' => [
            [
                'ApplicationId' => '<string>',
                'CompletedPieces' => <integer>,
                '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' => <integer>,
                'Failures' => ['<string>', ...],
                'Id' => '<string>',
                'JobStatus' => 'CREATED|PREPARING_FOR_INITIALIZATION|INITIALIZING|PROCESSING|PENDING_JOB|COMPLETING|COMPLETED|FAILING|FAILED',
                'TotalFailures' => <integer>,
                'TotalPieces' => <integer>,
                'TotalProcessed' => <integer>,
                'Type' => '<string>',
            ],
            // ...
        ],
        'NextToken' => '<string>',
    ],
]

Result Details

Members

ImportJobsResponse

: Required: Yes
: Type: ImportJobsResponse structure

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetSegmentVersion

$result = $client->getSegmentVersion([/* ... */]);
$promise = $client->getSegmentVersionAsync([/* ... */]);

Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.

Parameter Syntax

$result = $client->getSegmentVersion([
    'ApplicationId' => '<string>', // REQUIRED
    'SegmentId' => '<string>', // REQUIRED
    'Version' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

SegmentId

: Required: Yes
: Type: string

Version

: Required: Yes
: Type: string

Result Syntax

[
    'SegmentResponse' => [
        'ApplicationId' => '<string>',
        'Arn' => '<string>',
        'CreationDate' => '<string>',
        'Dimensions' => [
            'Attributes' => [
                '<__string>' => [
                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                    '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' => <float>,
                        'Longitude' => <float>,
                    ],
                    'RangeInKilometers' => <float>,
                ],
            ],
            'Metrics' => [
                '<__string>' => [
                    'ComparisonOperator' => '<string>',
                    'Value' => <float>,
                ],
                // ...
            ],
            'UserAttributes' => [
                '<__string>' => [
                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'Id' => '<string>',
        'ImportDefinition' => [
            'ChannelCounts' => [<integer>, ...],
            'ExternalId' => '<string>',
            'Format' => 'CSV|JSON',
            'RoleArn' => '<string>',
            'S3Url' => '<string>',
            'Size' => <integer>,
        ],
        'LastModifiedDate' => '<string>',
        'Name' => '<string>',
        'SegmentGroups' => [
            'Groups' => [
                [
                    'Dimensions' => [
                        [
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    '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' => <float>,
                                        'Longitude' => <float>,
                                    ],
                                    'RangeInKilometers' => <float>,
                                ],
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>',
                                    'Value' => <float>,
                                ],
                                // ...
                            ],
                            'UserAttributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'SourceSegments' => [
                        [
                            'Id' => '<string>',
                            'Version' => <integer>,
                        ],
                        // ...
                    ],
                    'SourceType' => 'ALL|ANY|NONE',
                    'Type' => 'ALL|ANY|NONE',
                ],
                // ...
            ],
            'Include' => 'ALL|ANY|NONE',
        ],
        'SegmentType' => 'DIMENSIONAL|IMPORT',
        'Version' => <integer>,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

SegmentResponse

: Required: Yes
: Type: SegmentResponse structure

Provides information about the configuration, dimension, and other settings for a segment.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetSegmentVersions

$result = $client->getSegmentVersions([/* ... */]);
$promise = $client->getSegmentVersionsAsync([/* ... */]);

Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.

Parameter Syntax

$result = $client->getSegmentVersions([
    'ApplicationId' => '<string>', // REQUIRED
    'PageSize' => '<string>',
    'SegmentId' => '<string>', // REQUIRED
    'Token' => '<string>',
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

PageSize

: Type: string

SegmentId

: Required: Yes
: Type: string

Token

: Type: string

Result Syntax

[
    'SegmentsResponse' => [
        'Item' => [
            [
                'ApplicationId' => '<string>',
                'Arn' => '<string>',
                'CreationDate' => '<string>',
                'Dimensions' => [
                    'Attributes' => [
                        '<__string>' => [
                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                            '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' => <float>,
                                'Longitude' => <float>,
                            ],
                            'RangeInKilometers' => <float>,
                        ],
                    ],
                    'Metrics' => [
                        '<__string>' => [
                            'ComparisonOperator' => '<string>',
                            'Value' => <float>,
                        ],
                        // ...
                    ],
                    'UserAttributes' => [
                        '<__string>' => [
                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                            'Values' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                'Id' => '<string>',
                'ImportDefinition' => [
                    'ChannelCounts' => [<integer>, ...],
                    'ExternalId' => '<string>',
                    'Format' => 'CSV|JSON',
                    'RoleArn' => '<string>',
                    'S3Url' => '<string>',
                    'Size' => <integer>,
                ],
                'LastModifiedDate' => '<string>',
                'Name' => '<string>',
                'SegmentGroups' => [
                    'Groups' => [
                        [
                            'Dimensions' => [
                                [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <float>,
                                                'Longitude' => <float>,
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>',
                                            'Value' => <float>,
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'SourceSegments' => [
                                [
                                    'Id' => '<string>',
                                    'Version' => <integer>,
                                ],
                                // ...
                            ],
                            'SourceType' => 'ALL|ANY|NONE',
                            'Type' => 'ALL|ANY|NONE',
                        ],
                        // ...
                    ],
                    'Include' => 'ALL|ANY|NONE',
                ],
                'SegmentType' => 'DIMENSIONAL|IMPORT',
                'Version' => <integer>,
                'tags' => ['<string>', ...],
            ],
            // ...
        ],
        'NextToken' => '<string>',
    ],
]

Result Details

Members

SegmentsResponse

: Required: Yes
: Type: SegmentsResponse structure

Provides information about all the segments that are associated with an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetSegments

$result = $client->getSegments([/* ... */]);
$promise = $client->getSegmentsAsync([/* ... */]);

Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.

Parameter Syntax

$result = $client->getSegments([
    'ApplicationId' => '<string>', // REQUIRED
    'PageSize' => '<string>',
    'Token' => '<string>',
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

PageSize

: Type: string

Token

: Type: string

Result Syntax

[
    'SegmentsResponse' => [
        'Item' => [
            [
                'ApplicationId' => '<string>',
                'Arn' => '<string>',
                'CreationDate' => '<string>',
                'Dimensions' => [
                    'Attributes' => [
                        '<__string>' => [
                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                            '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' => <float>,
                                'Longitude' => <float>,
                            ],
                            'RangeInKilometers' => <float>,
                        ],
                    ],
                    'Metrics' => [
                        '<__string>' => [
                            'ComparisonOperator' => '<string>',
                            'Value' => <float>,
                        ],
                        // ...
                    ],
                    'UserAttributes' => [
                        '<__string>' => [
                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                            'Values' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                'Id' => '<string>',
                'ImportDefinition' => [
                    'ChannelCounts' => [<integer>, ...],
                    'ExternalId' => '<string>',
                    'Format' => 'CSV|JSON',
                    'RoleArn' => '<string>',
                    'S3Url' => '<string>',
                    'Size' => <integer>,
                ],
                'LastModifiedDate' => '<string>',
                'Name' => '<string>',
                'SegmentGroups' => [
                    'Groups' => [
                        [
                            'Dimensions' => [
                                [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <float>,
                                                'Longitude' => <float>,
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>',
                                            'Value' => <float>,
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'SourceSegments' => [
                                [
                                    'Id' => '<string>',
                                    'Version' => <integer>,
                                ],
                                // ...
                            ],
                            'SourceType' => 'ALL|ANY|NONE',
                            'Type' => 'ALL|ANY|NONE',
                        ],
                        // ...
                    ],
                    'Include' => 'ALL|ANY|NONE',
                ],
                'SegmentType' => 'DIMENSIONAL|IMPORT',
                'Version' => <integer>,
                'tags' => ['<string>', ...],
            ],
            // ...
        ],
        'NextToken' => '<string>',
    ],
]

Result Details

Members

SegmentsResponse

: Required: Yes
: Type: SegmentsResponse structure

Provides information about all the segments that are associated with an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetSmsChannel

$result = $client->getSmsChannel([/* ... */]);
$promise = $client->getSmsChannelAsync([/* ... */]);

Retrieves information about the status and settings of the SMS channel for an application.

Parameter Syntax

$result = $client->getSmsChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result Syntax

[
    'SMSChannelResponse' => [
        'ApplicationId' => '<string>',
        'CreationDate' => '<string>',
        'Enabled' => true || false,
        'HasCredential' => true || false,
        'Id' => '<string>',
        'IsArchived' => true || false,
        'LastModifiedBy' => '<string>',
        'LastModifiedDate' => '<string>',
        'Platform' => '<string>',
        'PromotionalMessagesPerSecond' => <integer>,
        'SenderId' => '<string>',
        'ShortCode' => '<string>',
        'TransactionalMessagesPerSecond' => <integer>,
        'Version' => <integer>,
    ],
]

Result Details

Members

SMSChannelResponse

: Required: Yes
: Type: SMSChannelResponse structure

Provides information about the status and settings of the SMS channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetSmsTemplate

$result = $client->getSmsTemplate([/* ... */]);
$promise = $client->getSmsTemplateAsync([/* ... */]);

Retrieves the content and settings of a message template for messages that are sent through the SMS channel.

Parameter Syntax

$result = $client->getSmsTemplate([
    'TemplateName' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members

TemplateName

: Required: Yes
: Type: string

Version

: Type: string

Result Syntax

[
    'SMSTemplateResponse' => [
        'Arn' => '<string>',
        'Body' => '<string>',
        'CreationDate' => '<string>',
        'DefaultSubstitutions' => '<string>',
        'LastModifiedDate' => '<string>',
        'RecommenderId' => '<string>',
        'TemplateDescription' => '<string>',
        'TemplateName' => '<string>',
        'TemplateType' => 'EMAIL|SMS|VOICE|PUSH|INAPP',
        'Version' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

SMSTemplateResponse

: Required: Yes
: Type: SMSTemplateResponse structure

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.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetUserEndpoint

$result = $client->getUserEndpoint([/* ... */]);
$promise = $client->getUserEndpointAsync([/* ... */]);

Retrieves information about the settings and attributes of a specific endpoint for an application.

Parameter Syntax

$result = $client->getUserEndpoint([
    'ApplicationId' => '<string>', // REQUIRED
    'EndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

EndpointId

: Required: Yes
: Type: string

Result 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' => <float>,
            'Longitude' => <float>,
            'PostalCode' => '<string>',
            'Region' => '<string>',
        ],
        'Metrics' => [<float>, ...],
        'OptOut' => '<string>',
        'RequestId' => '<string>',
        'User' => [
            'UserAttributes' => [
                '<__string>' => ['<string>', ...],
                // ...
            ],
            'UserId' => '<string>',
        ],
    ],
]

Result Details

Members

EndpointResponse

: Required: Yes
: Type: EndpointResponse structure

Provides information about the channel type and other settings for an endpoint.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetUserEndpoints

$result = $client->getUserEndpoints([/* ... */]);
$promise = $client->getUserEndpointsAsync([/* ... */]);

Retrieves information about all the endpoints that are associated with a specific user ID.

Parameter Syntax

$result = $client->getUserEndpoints([
    'ApplicationId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

UserId

: Required: Yes
: Type: string

Result 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' => <float>,
                    'Longitude' => <float>,
                    'PostalCode' => '<string>',
                    'Region' => '<string>',
                ],
                'Metrics' => [<float>, ...],
                'OptOut' => '<string>',
                'RequestId' => '<string>',
                'User' => [
                    'UserAttributes' => [
                        '<__string>' => ['<string>', ...],
                        // ...
                    ],
                    'UserId' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members

EndpointsResponse

: Required: Yes
: Type: EndpointsResponse structure

Provides information about all the endpoints that are associated with a user ID.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetVoiceChannel

$result = $client->getVoiceChannel([/* ... */]);
$promise = $client->getVoiceChannelAsync([/* ... */]);

Retrieves information about the status and settings of the voice channel for an application.

Parameter Syntax

$result = $client->getVoiceChannel([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

Result Syntax

[
    'VoiceChannelResponse' => [
        'ApplicationId' => '<string>',
        'CreationDate' => '<string>',
        'Enabled' => true || false,
        'HasCredential' => true || false,
        'Id' => '<string>',
        'IsArchived' => true || false,
        'LastModifiedBy' => '<string>',
        'LastModifiedDate' => '<string>',
        'Platform' => '<string>',
        'Version' => <integer>,
    ],
]

Result Details

Members

VoiceChannelResponse

: Required: Yes
: Type: VoiceChannelResponse structure

Provides information about the status and settings of the voice channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

GetVoiceTemplate

$result = $client->getVoiceTemplate([/* ... */]);
$promise = $client->getVoiceTemplateAsync([/* ... */]);

Retrieves the content and settings of a message template for messages that are sent through the voice channel.

Parameter Syntax

$result = $client->getVoiceTemplate([
    'TemplateName' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members

TemplateName

: Required: Yes
: Type: string

Version

: Type: string

Result Syntax

[
    'VoiceTemplateResponse' => [
        'Arn' => '<string>',
        'Body' => '<string>',
        'CreationDate' => '<string>',
        'DefaultSubstitutions' => '<string>',
        'LanguageCode' => '<string>',
        'LastModifiedDate' => '<string>',
        'TemplateDescription' => '<string>',
        'TemplateName' => '<string>',
        'TemplateType' => 'EMAIL|SMS|VOICE|PUSH|INAPP',
        'Version' => '<string>',
        'VoiceId' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

VoiceTemplateResponse

: Required: Yes
: Type: VoiceTemplateResponse structure

Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

ListJourneys

$result = $client->listJourneys([/* ... */]);
$promise = $client->listJourneysAsync([/* ... */]);

Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.

Parameter Syntax

$result = $client->listJourneys([
    'ApplicationId' => '<string>', // REQUIRED
    'PageSize' => '<string>',
    'Token' => '<string>',
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

PageSize

: Type: string

Token

: Type: string

Result Syntax

[
    'JourneysResponse' => [
        'Item' => [
            [
                'Activities' => [
                    '<__string>' => [
                        'CUSTOM' => [
                            'DeliveryUri' => '<string>',
                            'EndpointTypes' => ['<string>', ...],
                            'MessageConfig' => [
                                'Data' => '<string>',
                            ],
                            'NextActivity' => '<string>',
                            'TemplateName' => '<string>',
                            'TemplateVersion' => '<string>',
                        ],
                        'ConditionalSplit' => [
                            'Condition' => [
                                'Conditions' => [
                                    [
                                        'EventCondition' => [
                                            'Dimensions' => [
                                                'Attributes' => [
                                                    '<__string>' => [
                                                        'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                        'Values' => ['<string>', ...],
                                                    ],
                                                    // ...
                                                ],
                                                'EventType' => [
                                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                                    'Values' => ['<string>', ...],
                                                ],
                                                'Metrics' => [
                                                    '<__string>' => [
                                                        'ComparisonOperator' => '<string>',
                                                        'Value' => <float>,
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                            'MessageActivity' => '<string>',
                                        ],
                                        'SegmentCondition' => [
                                            'SegmentId' => '<string>',
                                        ],
                                        'SegmentDimensions' => [
                                            'Attributes' => [
                                                '<__string>' => [
                                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                    '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' => <float>,
                                                        'Longitude' => <float>,
                                                    ],
                                                    'RangeInKilometers' => <float>,
                                                ],
                                            ],
                                            'Metrics' => [
                                                '<__string>' => [
                                                    'ComparisonOperator' => '<string>',
                                                    'Value' => <float>,
                                                ],
                                                // ...
                                            ],
                                            'UserAttributes' => [
                                                '<__string>' => [
                                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                    'Values' => ['<string>', ...],
                                                ],
                                                // ...
                                            ],
                                        ],
                                    ],
                                    // ...
                                ],
                                'Operator' => 'ALL|ANY',
                            ],
                            'EvaluationWaitTime' => [
                                'WaitFor' => '<string>',
                                'WaitUntil' => '<string>',
                            ],
                            'FalseActivity' => '<string>',
                            'TrueActivity' => '<string>',
                        ],
                        'ContactCenter' => [
                            'NextActivity' => '<string>',
                        ],
                        'Description' => '<string>',
                        'EMAIL' => [
                            'MessageConfig' => [
                                'FromAddress' => '<string>',
                            ],
                            'NextActivity' => '<string>',
                            'TemplateName' => '<string>',
                            'TemplateVersion' => '<string>',
                        ],
                        'Holdout' => [
                            'NextActivity' => '<string>',
                            'Percentage' => <integer>,
                        ],
                        'MultiCondition' => [
                            'Branches' => [
                                [
                                    'Condition' => [
                                        'EventCondition' => [
                                            'Dimensions' => [
                                                'Attributes' => [
                                                    '<__string>' => [
                                                        'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                        'Values' => ['<string>', ...],
                                                    ],
                                                    // ...
                                                ],
                                                'EventType' => [
                                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                                    'Values' => ['<string>', ...],
                                                ],
                                                'Metrics' => [
                                                    '<__string>' => [
                                                        'ComparisonOperator' => '<string>',
                                                        'Value' => <float>,
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                            'MessageActivity' => '<string>',
                                        ],
                                        'SegmentCondition' => [
                                            'SegmentId' => '<string>',
                                        ],
                                        'SegmentDimensions' => [
                                            'Attributes' => [
                                                '<__string>' => [
                                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                    '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' => <float>,
                                                        'Longitude' => <float>,
                                                    ],
                                                    'RangeInKilometers' => <float>,
                                                ],
                                            ],
                                            'Metrics' => [
                                                '<__string>' => [
                                                    'ComparisonOperator' => '<string>',
                                                    'Value' => <float>,
                                                ],
                                                // ...
                                            ],
                                            'UserAttributes' => [
                                                '<__string>' => [
                                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                    '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' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        'SMS' => [
                            'MessageConfig' => [
                                'EntityId' => '<string>',
                                'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                                'OriginationNumber' => '<string>',
                                'SenderId' => '<string>',
                                'TemplateId' => '<string>',
                            ],
                            'NextActivity' => '<string>',
                            'TemplateName' => '<string>',
                            'TemplateVersion' => '<string>',
                        ],
                        'Wait' => [
                            'NextActivity' => '<string>',
                            'WaitTime' => [
                                'WaitFor' => '<string>',
                                'WaitUntil' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
                'ApplicationId' => '<string>',
                'ClosedDays' => [
                    'CUSTOM' => [
                        [
                            'EndDateTime' => '<string>',
                            'Name' => '<string>',
                            'StartDateTime' => '<string>',
                        ],
                        // ...
                    ],
                    'EMAIL' => [
                        [
                            'EndDateTime' => '<string>',
                            'Name' => '<string>',
                            'StartDateTime' => '<string>',
                        ],
                        // ...
                    ],
                    'PUSH' => [
                        [
                            'EndDateTime' => '<string>',
                            'Name' => '<string>',
                            'StartDateTime' => '<string>',
                        ],
                        // ...
                    ],
                    'SMS' => [
                        [
                            'EndDateTime' => '<string>',
                            'Name' => '<string>',
                            'StartDateTime' => '<string>',
                        ],
                        // ...
                    ],
                    'VOICE' => [
                        [
                            'EndDateTime' => '<string>',
                            'Name' => '<string>',
                            'StartDateTime' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'CreationDate' => '<string>',
                'Id' => '<string>',
                'JourneyChannelSettings' => [
                    'ConnectCampaignArn' => '<string>',
                    'ConnectCampaignExecutionRoleArn' => '<string>',
                ],
                'LastModifiedDate' => '<string>',
                'Limits' => [
                    'DailyCap' => <integer>,
                    'EndpointReentryCap' => <integer>,
                    'EndpointReentryInterval' => '<string>',
                    'MessagesPerSecond' => <integer>,
                    'TimeframeCap' => [
                        'Cap' => <integer>,
                        'Days' => <integer>,
                    ],
                    'TotalCap' => <integer>,
                ],
                'LocalTime' => true || false,
                'Name' => '<string>',
                'OpenHours' => [
                    'CUSTOM' => [
                        '<DayOfWeek>' => [
                            [
                                'EndTime' => '<string>',
                                'StartTime' => '<string>',
                            ],
                            // ...
                        ],
                        // ...
                    ],
                    'EMAIL' => [
                        '<DayOfWeek>' => [
                            [
                                'EndTime' => '<string>',
                                'StartTime' => '<string>',
                            ],
                            // ...
                        ],
                        // ...
                    ],
                    'PUSH' => [
                        '<DayOfWeek>' => [
                            [
                                'EndTime' => '<string>',
                                'StartTime' => '<string>',
                            ],
                            // ...
                        ],
                        // ...
                    ],
                    'SMS' => [
                        '<DayOfWeek>' => [
                            [
                                'EndTime' => '<string>',
                                'StartTime' => '<string>',
                            ],
                            // ...
                        ],
                        // ...
                    ],
                    'VOICE' => [
                        '<DayOfWeek>' => [
                            [
                                'EndTime' => '<string>',
                                'StartTime' => '<string>',
                            ],
                            // ...
                        ],
                        // ...
                    ],
                ],
                'QuietTime' => [
                    'End' => '<string>',
                    'Start' => '<string>',
                ],
                'RefreshFrequency' => '<string>',
                'RefreshOnSegmentUpdate' => true || false,
                'Schedule' => [
                    'EndTime' => <DateTime>,
                    'StartTime' => <DateTime>,
                    'Timezone' => '<string>',
                ],
                'SendingSchedule' => true || false,
                'StartActivity' => '<string>',
                'StartCondition' => [
                    'Description' => '<string>',
                    'EventStartCondition' => [
                        'EventFilter' => [
                            'Dimensions' => [
                                'Attributes' => [
                                    '<__string>' => [
                                        'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                        'Values' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                                'EventType' => [
                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                    'Values' => ['<string>', ...],
                                ],
                                'Metrics' => [
                                    '<__string>' => [
                                        'ComparisonOperator' => '<string>',
                                        'Value' => <float>,
                                    ],
                                    // ...
                                ],
                            ],
                            'FilterType' => 'SYSTEM|ENDPOINT',
                        ],
                        'SegmentId' => '<string>',
                    ],
                    'SegmentStartCondition' => [
                        'SegmentId' => '<string>',
                    ],
                ],
                'State' => 'DRAFT|ACTIVE|COMPLETED|CANCELLED|CLOSED|PAUSED',
                'TimezoneEstimationMethods' => ['<string>', ...],
                'WaitForQuietTime' => true || false,
                'tags' => ['<string>', ...],
            ],
            // ...
        ],
        'NextToken' => '<string>',
    ],
]

Result Details

Members

JourneysResponse

: Required: Yes
: Type: JourneysResponse structure

Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

Result Syntax

[
    'TagsModel' => [
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

TagsModel

: Required: Yes
: Type: TagsModel structure

Specifies the tags (keys and values) for an application, campaign, message template, or segment.

Errors

There are no errors described for this operation.

ListTemplateVersions

$result = $client->listTemplateVersions([/* ... */]);
$promise = $client->listTemplateVersionsAsync([/* ... */]);

Retrieves information about all the versions of a specific message template.

Parameter Syntax

$result = $client->listTemplateVersions([
    'NextToken' => '<string>',
    'PageSize' => '<string>',
    'TemplateName' => '<string>', // REQUIRED
    'TemplateType' => '<string>', // REQUIRED
]);

Parameter Details

Members

NextToken

: Type: string

PageSize

: Type: string

TemplateName

: Required: Yes
: Type: string

TemplateType

: Required: Yes
: Type: string

Result Syntax

[
    'TemplateVersionsResponse' => [
        'Item' => [
            [
                'CreationDate' => '<string>',
                'DefaultSubstitutions' => '<string>',
                'LastModifiedDate' => '<string>',
                'TemplateDescription' => '<string>',
                'TemplateName' => '<string>',
                'TemplateType' => '<string>',
                'Version' => '<string>',
            ],
            // ...
        ],
        'Message' => '<string>',
        'NextToken' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

TemplateVersionsResponse

: Required: Yes
: Type: TemplateVersionsResponse structure

Provides information about all the versions of a specific message template.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

ListTemplates

$result = $client->listTemplates([/* ... */]);
$promise = $client->listTemplatesAsync([/* ... */]);

Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.

Parameter Syntax

$result = $client->listTemplates([
    'NextToken' => '<string>',
    'PageSize' => '<string>',
    'Prefix' => '<string>',
    'TemplateType' => '<string>',
]);

Parameter Details

Members

NextToken

: Type: string

PageSize

: Type: string

Prefix

: Type: string

TemplateType

: Type: string

Result Syntax

[
    'TemplatesResponse' => [
        'Item' => [
            [
                'Arn' => '<string>',
                'CreationDate' => '<string>',
                'DefaultSubstitutions' => '<string>',
                'LastModifiedDate' => '<string>',
                'TemplateDescription' => '<string>',
                'TemplateName' => '<string>',
                'TemplateType' => 'EMAIL|SMS|VOICE|PUSH|INAPP',
                'Version' => '<string>',
                'tags' => ['<string>', ...],
            ],
            // ...
        ],
        'NextToken' => '<string>',
    ],
]

Result Details

Members

TemplatesResponse

: Required: Yes
: Type: TemplatesResponse structure

Provides information about all the message templates that are associated with your Amazon Pinpoint account.

Errors

MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.
BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.

PhoneNumberValidate

$result = $client->phoneNumberValidate([/* ... */]);
$promise = $client->phoneNumberValidateAsync([/* ... */]);

Retrieves information about a phone number.

Parameter Syntax

$result = $client->phoneNumberValidate([
    'NumberValidateRequest' => [ // REQUIRED
        'IsoCountryCode' => '<string>',
        'PhoneNumber' => '<string>',
    ],
]);

Parameter Details

Members

NumberValidateRequest

: Required: Yes
: Type: NumberValidateRequest structure

Specifies a phone number to validate and retrieve information about.

Result Syntax

[
    'NumberValidateResponse' => [
        'Carrier' => '<string>',
        'City' => '<string>',
        'CleansedPhoneNumberE164' => '<string>',
        'CleansedPhoneNumberNational' => '<string>',
        'Country' => '<string>',
        'CountryCodeIso2' => '<string>',
        'CountryCodeNumeric' => '<string>',
        'County' => '<string>',
        'OriginalCountryCodeIso2' => '<string>',
        'OriginalPhoneNumber' => '<string>',
        'PhoneType' => '<string>',
        'PhoneTypeCode' => <integer>,
        'Timezone' => '<string>',
        'ZipCode' => '<string>',
    ],
]

Result Details

Members

NumberValidateResponse

: Required: Yes
: Type: NumberValidateResponse structure

Provides information about a phone number.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

PutEventStream

$result = $client->putEventStream([/* ... */]);
$promise = $client->putEventStreamAsync([/* ... */]);

Creates a new event stream for an application or updates the settings of an existing event stream for an application.

Parameter Syntax

$result = $client->putEventStream([
    'ApplicationId' => '<string>', // REQUIRED
    'WriteEventStream' => [ // REQUIRED
        'DestinationStreamArn' => '<string>', // REQUIRED
        'RoleArn' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

WriteEventStream

: Required: Yes
: Type: WriteEventStream structure

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.

Result Syntax

[
    'EventStream' => [
        'ApplicationId' => '<string>',
        'DestinationStreamArn' => '<string>',
        'ExternalId' => '<string>',
        'LastModifiedDate' => '<string>',
        'LastUpdatedBy' => '<string>',
        'RoleArn' => '<string>',
    ],
]

Result Details

Members

EventStream

: Required: Yes
: Type: EventStream structure

Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

PutEvents

$result = $client->putEvents([/* ... */]);
$promise = $client->putEventsAsync([/* ... */]);

Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.

Parameter Syntax

$result = $client->putEvents([
    'ApplicationId' => '<string>', // REQUIRED
    'EventsRequest' => [ // REQUIRED
        'BatchItem' => [ // REQUIRED
            '<__string>' => [
                'Endpoint' => [ // REQUIRED
                    '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' => <float>,
                        'Longitude' => <float>,
                        'PostalCode' => '<string>',
                        'Region' => '<string>',
                    ],
                    'Metrics' => [<float>, ...],
                    'OptOut' => '<string>',
                    'RequestId' => '<string>',
                    'User' => [
                        'UserAttributes' => [
                            '<__string>' => ['<string>', ...],
                            // ...
                        ],
                        'UserId' => '<string>',
                    ],
                ],
                'Events' => [ // REQUIRED
                    '<__string>' => [
                        'AppPackageName' => '<string>',
                        'AppTitle' => '<string>',
                        'AppVersionCode' => '<string>',
                        'Attributes' => ['<string>', ...],
                        'ClientSdkVersion' => '<string>',
                        'EventType' => '<string>', // REQUIRED
                        'Metrics' => [<float>, ...],
                        'SdkName' => '<string>',
                        'Session' => [
                            'Duration' => <integer>,
                            'Id' => '<string>', // REQUIRED
                            'StartTimestamp' => '<string>', // REQUIRED
                            'StopTimestamp' => '<string>',
                        ],
                        'Timestamp' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

EventsRequest

: Required: Yes
: Type: EventsRequest structure

Specifies a batch of events to process.

Result Syntax

[
    'EventsResponse' => [
        'Results' => [
            '<__string>' => [
                'EndpointItemResponse' => [
                    'Message' => '<string>',
                    'StatusCode' => <integer>,
                ],
                'EventsItemResponse' => [
                    '<__string>' => [
                        'Message' => '<string>',
                        'StatusCode' => <integer>,
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members

EventsResponse

: Required: Yes
: Type: EventsResponse structure

Provides information about endpoints and the events that they're associated with.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

RemoveAttributes

$result = $client->removeAttributes([/* ... */]);
$promise = $client->removeAttributesAsync([/* ... */]);

Removes one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes.

Parameter Syntax

$result = $client->removeAttributes([
    'ApplicationId' => '<string>', // REQUIRED
    'AttributeType' => '<string>', // REQUIRED
    'UpdateAttributesRequest' => [ // REQUIRED
        'Blacklist' => ['<string>', ...],
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

AttributeType

: Required: Yes
: Type: string

UpdateAttributesRequest

: Required: Yes
: Type: UpdateAttributesRequest structure

Specifies one or more attributes to remove from all the endpoints that are associated with an application.

Result Syntax

[
    'AttributesResource' => [
        'ApplicationId' => '<string>',
        'AttributeType' => '<string>',
        'Attributes' => ['<string>', ...],
    ],
]

Result Details

Members

AttributesResource

: Required: Yes
: Type: AttributesResource structure

Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

SendMessages

$result = $client->sendMessages([/* ... */]);
$promise = $client->sendMessagesAsync([/* ... */]);

Creates and sends a direct message.

Parameter Syntax

$result = $client->sendMessages([
    'ApplicationId' => '<string>', // REQUIRED
    'MessageRequest' => [ // REQUIRED
        '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>', ...],
                'RawContent' => '<string>',
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
                'TitleOverride' => '<string>',
            ],
            // ...
        ],
        'Context' => ['<string>', ...],
        'Endpoints' => [
            '<__string>' => [
                'BodyOverride' => '<string>',
                'Context' => ['<string>', ...],
                'RawContent' => '<string>',
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
                'TitleOverride' => '<string>',
            ],
            // ...
        ],
        'MessageConfiguration' => [ // REQUIRED
            'ADMMessage' => [
                'Action' => 'OPEN_APP|DEEP_LINK|URL',
                'Body' => '<string>',
                'ConsolidationKey' => '<string>',
                'Data' => ['<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' => <integer>,
                'Body' => '<string>',
                'Category' => '<string>',
                'CollapseId' => '<string>',
                'Data' => ['<string>', ...],
                'MediaUrl' => '<string>',
                'PreferredAuthenticationMethod' => '<string>',
                'Priority' => '<string>',
                'RawContent' => '<string>',
                'SilentPush' => true || false,
                'Sound' => '<string>',
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
                'ThreadId' => '<string>',
                'TimeToLive' => <integer>,
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'BaiduMessage' => [
                'Action' => 'OPEN_APP|DEEP_LINK|URL',
                'Body' => '<string>',
                'Data' => ['<string>', ...],
                'IconReference' => '<string>',
                'ImageIconUrl' => '<string>',
                'ImageUrl' => '<string>',
                'RawContent' => '<string>',
                'SilentPush' => true || false,
                'SmallImageIconUrl' => '<string>',
                'Sound' => '<string>',
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
                'TimeToLive' => <integer>,
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'DefaultMessage' => [
                'Body' => '<string>',
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
            ],
            'DefaultPushNotificationMessage' => [
                'Action' => 'OPEN_APP|DEEP_LINK|URL',
                'Body' => '<string>',
                'Data' => ['<string>', ...],
                'SilentPush' => true || false,
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'EmailMessage' => [
                'Body' => '<string>',
                'FeedbackForwardingAddress' => '<string>',
                'FromAddress' => '<string>',
                'RawEmail' => [
                    'Data' => <string || resource || Psr\Http\Message\StreamInterface>,
                ],
                'ReplyToAddresses' => ['<string>', ...],
                'SimpleEmail' => [
                    'Headers' => [
                        [
                            'Name' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    '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>', ...],
                'IconReference' => '<string>',
                'ImageIconUrl' => '<string>',
                'ImageUrl' => '<string>',
                'PreferredAuthenticationMethod' => '<string>',
                'Priority' => '<string>',
                'RawContent' => '<string>',
                'RestrictedPackageName' => '<string>',
                'SilentPush' => true || false,
                'SmallImageIconUrl' => '<string>',
                'Sound' => '<string>',
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
                'TimeToLive' => <integer>,
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'SMSMessage' => [
                'Body' => '<string>',
                'EntityId' => '<string>',
                'Keyword' => '<string>',
                'MediaUrl' => '<string>',
                'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                'OriginationNumber' => '<string>',
                'SenderId' => '<string>',
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
                'TemplateId' => '<string>',
            ],
            'VoiceMessage' => [
                'Body' => '<string>',
                'LanguageCode' => '<string>',
                'OriginationNumber' => '<string>',
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
                'VoiceId' => '<string>',
            ],
        ],
        'TemplateConfiguration' => [
            'EmailTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'InAppTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'PushTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'SMSTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'VoiceTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
        ],
        'TraceId' => '<string>',
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

MessageRequest

: Required: Yes
: Type: MessageRequest structure

Specifies the configuration and other settings for a message.

Result Syntax

[
    'MessageResponse' => [
        'ApplicationId' => '<string>',
        'EndpointResult' => [
            '<__string>' => [
                'Address' => '<string>',
                'DeliveryStatus' => 'SUCCESSFUL|THROTTLED|TEMPORARY_FAILURE|PERMANENT_FAILURE|UNKNOWN_FAILURE|OPT_OUT|DUPLICATE',
                'MessageId' => '<string>',
                'StatusCode' => <integer>,
                'StatusMessage' => '<string>',
                'UpdatedToken' => '<string>',
            ],
            // ...
        ],
        'RequestId' => '<string>',
        'Result' => [
            '<__string>' => [
                'DeliveryStatus' => 'SUCCESSFUL|THROTTLED|TEMPORARY_FAILURE|PERMANENT_FAILURE|UNKNOWN_FAILURE|OPT_OUT|DUPLICATE',
                'MessageId' => '<string>',
                'StatusCode' => <integer>,
                'StatusMessage' => '<string>',
                'UpdatedToken' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

MessageResponse

: Required: Yes
: Type: MessageResponse structure

Provides information about the results of a request to send a message to an endpoint address.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

SendOTPMessage

$result = $client->sendOTPMessage([/* ... */]);
$promise = $client->sendOTPMessageAsync([/* ... */]);

Send an OTP message

Parameter Syntax

$result = $client->sendOTPMessage([
    'ApplicationId' => '<string>', // REQUIRED
    'SendOTPMessageRequestParameters' => [ // REQUIRED
        'AllowedAttempts' => <integer>,
        'BrandName' => '<string>', // REQUIRED
        'Channel' => '<string>', // REQUIRED
        'CodeLength' => <integer>,
        'DestinationIdentity' => '<string>', // REQUIRED
        'EntityId' => '<string>',
        'Language' => '<string>',
        'OriginationIdentity' => '<string>', // REQUIRED
        'ReferenceId' => '<string>', // REQUIRED
        'TemplateId' => '<string>',
        'ValidityPeriod' => <integer>,
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

SendOTPMessageRequestParameters

: Required: Yes
: Type: SendOTPMessageRequestParameters structure

Send OTP message request parameters.

Result Syntax

[
    'MessageResponse' => [
        'ApplicationId' => '<string>',
        'EndpointResult' => [
            '<__string>' => [
                'Address' => '<string>',
                'DeliveryStatus' => 'SUCCESSFUL|THROTTLED|TEMPORARY_FAILURE|PERMANENT_FAILURE|UNKNOWN_FAILURE|OPT_OUT|DUPLICATE',
                'MessageId' => '<string>',
                'StatusCode' => <integer>,
                'StatusMessage' => '<string>',
                'UpdatedToken' => '<string>',
            ],
            // ...
        ],
        'RequestId' => '<string>',
        'Result' => [
            '<__string>' => [
                'DeliveryStatus' => 'SUCCESSFUL|THROTTLED|TEMPORARY_FAILURE|PERMANENT_FAILURE|UNKNOWN_FAILURE|OPT_OUT|DUPLICATE',
                'MessageId' => '<string>',
                'StatusCode' => <integer>,
                'StatusMessage' => '<string>',
                'UpdatedToken' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

MessageResponse

: Required: Yes
: Type: MessageResponse structure

Provides information about the results of a request to send a message to an endpoint address.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

SendUsersMessages

$result = $client->sendUsersMessages([/* ... */]);
$promise = $client->sendUsersMessagesAsync([/* ... */]);

Creates and sends a message to a list of users.

Parameter Syntax

$result = $client->sendUsersMessages([
    'ApplicationId' => '<string>', // REQUIRED
    'SendUsersMessageRequest' => [ // REQUIRED
        'Context' => ['<string>', ...],
        'MessageConfiguration' => [ // REQUIRED
            'ADMMessage' => [
                'Action' => 'OPEN_APP|DEEP_LINK|URL',
                'Body' => '<string>',
                'ConsolidationKey' => '<string>',
                'Data' => ['<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' => <integer>,
                'Body' => '<string>',
                'Category' => '<string>',
                'CollapseId' => '<string>',
                'Data' => ['<string>', ...],
                'MediaUrl' => '<string>',
                'PreferredAuthenticationMethod' => '<string>',
                'Priority' => '<string>',
                'RawContent' => '<string>',
                'SilentPush' => true || false,
                'Sound' => '<string>',
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
                'ThreadId' => '<string>',
                'TimeToLive' => <integer>,
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'BaiduMessage' => [
                'Action' => 'OPEN_APP|DEEP_LINK|URL',
                'Body' => '<string>',
                'Data' => ['<string>', ...],
                'IconReference' => '<string>',
                'ImageIconUrl' => '<string>',
                'ImageUrl' => '<string>',
                'RawContent' => '<string>',
                'SilentPush' => true || false,
                'SmallImageIconUrl' => '<string>',
                'Sound' => '<string>',
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
                'TimeToLive' => <integer>,
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'DefaultMessage' => [
                'Body' => '<string>',
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
            ],
            'DefaultPushNotificationMessage' => [
                'Action' => 'OPEN_APP|DEEP_LINK|URL',
                'Body' => '<string>',
                'Data' => ['<string>', ...],
                'SilentPush' => true || false,
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'EmailMessage' => [
                'Body' => '<string>',
                'FeedbackForwardingAddress' => '<string>',
                'FromAddress' => '<string>',
                'RawEmail' => [
                    'Data' => <string || resource || Psr\Http\Message\StreamInterface>,
                ],
                'ReplyToAddresses' => ['<string>', ...],
                'SimpleEmail' => [
                    'Headers' => [
                        [
                            'Name' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    '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>', ...],
                'IconReference' => '<string>',
                'ImageIconUrl' => '<string>',
                'ImageUrl' => '<string>',
                'PreferredAuthenticationMethod' => '<string>',
                'Priority' => '<string>',
                'RawContent' => '<string>',
                'RestrictedPackageName' => '<string>',
                'SilentPush' => true || false,
                'SmallImageIconUrl' => '<string>',
                'Sound' => '<string>',
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
                'TimeToLive' => <integer>,
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'SMSMessage' => [
                'Body' => '<string>',
                'EntityId' => '<string>',
                'Keyword' => '<string>',
                'MediaUrl' => '<string>',
                'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                'OriginationNumber' => '<string>',
                'SenderId' => '<string>',
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
                'TemplateId' => '<string>',
            ],
            'VoiceMessage' => [
                'Body' => '<string>',
                'LanguageCode' => '<string>',
                'OriginationNumber' => '<string>',
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
                'VoiceId' => '<string>',
            ],
        ],
        'TemplateConfiguration' => [
            'EmailTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'InAppTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'PushTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'SMSTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'VoiceTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
        ],
        'TraceId' => '<string>',
        'Users' => [ // REQUIRED
            '<__string>' => [
                'BodyOverride' => '<string>',
                'Context' => ['<string>', ...],
                'RawContent' => '<string>',
                'Substitutions' => [
                    '<__string>' => ['<string>', ...],
                    // ...
                ],
                'TitleOverride' => '<string>',
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

SendUsersMessageRequest

: Required: Yes
: Type: SendUsersMessageRequest structure

Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.

Result 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' => <integer>,
                    'StatusMessage' => '<string>',
                    'UpdatedToken' => '<string>',
                ],
                // ...
            ],
            // ...
        ],
    ],
]

Result Details

Members

SendUsersMessageResponse

: Required: Yes
: Type: SendUsersMessageResponse structure

Provides information about which users and endpoints a message was sent to.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds one or more tags (keys and values) to an application, campaign, message template, or segment.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagsModel' => [ // REQUIRED
        'tags' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

TagsModel

: Required: Yes
: Type: TagsModel structure

Specifies the tags (keys and values) for an application, campaign, message template, or segment.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags (keys and values) from an application, campaign, message template, or segment.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

TagKeys

: Required: Yes
: Type: Array of strings

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

UpdateAdmChannel

$result = $client->updateAdmChannel([/* ... */]);
$promise = $client->updateAdmChannelAsync([/* ... */]);

Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.

Parameter Syntax

$result = $client->updateAdmChannel([
    'ADMChannelRequest' => [ // REQUIRED
        'ClientId' => '<string>', // REQUIRED
        'ClientSecret' => '<string>', // REQUIRED
        'Enabled' => true || false,
    ],
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ADMChannelRequest

: Required: Yes
: Type: ADMChannelRequest structure

Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.

ApplicationId

: Required: Yes
: Type: string

Result Syntax

[
    'ADMChannelResponse' => [
        'ApplicationId' => '<string>',
        'CreationDate' => '<string>',
        'Enabled' => true || false,
        'HasCredential' => true || false,
        'Id' => '<string>',
        'IsArchived' => true || false,
        'LastModifiedBy' => '<string>',
        'LastModifiedDate' => '<string>',
        'Platform' => '<string>',
        'Version' => <integer>,
    ],
]

Result Details

Members

ADMChannelResponse

: Required: Yes
: Type: ADMChannelResponse structure

Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateApnsChannel

$result = $client->updateApnsChannel([/* ... */]);
$promise = $client->updateApnsChannelAsync([/* ... */]);

Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.

Parameter Syntax

$result = $client->updateApnsChannel([
    'APNSChannelRequest' => [ // REQUIRED
        'BundleId' => '<string>',
        'Certificate' => '<string>',
        'DefaultAuthenticationMethod' => '<string>',
        'Enabled' => true || false,
        'PrivateKey' => '<string>',
        'TeamId' => '<string>',
        'TokenKey' => '<string>',
        'TokenKeyId' => '<string>',
    ],
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

APNSChannelRequest

: Required: Yes
: Type: APNSChannelRequest structure

Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
    ],
]

Result Details

Members

APNSChannelResponse

: Required: Yes
: Type: APNSChannelResponse structure

Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateApnsSandboxChannel

$result = $client->updateApnsSandboxChannel([/* ... */]);
$promise = $client->updateApnsSandboxChannelAsync([/* ... */]);

Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.

Parameter Syntax

$result = $client->updateApnsSandboxChannel([
    'APNSSandboxChannelRequest' => [ // REQUIRED
        'BundleId' => '<string>',
        'Certificate' => '<string>',
        'DefaultAuthenticationMethod' => '<string>',
        'Enabled' => true || false,
        'PrivateKey' => '<string>',
        'TeamId' => '<string>',
        'TokenKey' => '<string>',
        'TokenKeyId' => '<string>',
    ],
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

APNSSandboxChannelRequest

: Required: Yes
: Type: APNSSandboxChannelRequest structure

Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
    ],
]

Result Details

Members

APNSSandboxChannelResponse

: Required: Yes
: Type: APNSSandboxChannelResponse structure

Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateApnsVoipChannel

$result = $client->updateApnsVoipChannel([/* ... */]);
$promise = $client->updateApnsVoipChannelAsync([/* ... */]);

Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.

Parameter Syntax

$result = $client->updateApnsVoipChannel([
    'APNSVoipChannelRequest' => [ // REQUIRED
        'BundleId' => '<string>',
        'Certificate' => '<string>',
        'DefaultAuthenticationMethod' => '<string>',
        'Enabled' => true || false,
        'PrivateKey' => '<string>',
        'TeamId' => '<string>',
        'TokenKey' => '<string>',
        'TokenKeyId' => '<string>',
    ],
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

APNSVoipChannelRequest

: Required: Yes
: Type: APNSVoipChannelRequest structure

Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
    ],
]

Result Details

Members

APNSVoipChannelResponse

: Required: Yes
: Type: APNSVoipChannelResponse structure

Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateApnsVoipSandboxChannel

$result = $client->updateApnsVoipSandboxChannel([/* ... */]);
$promise = $client->updateApnsVoipSandboxChannelAsync([/* ... */]);

Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.

Parameter Syntax

$result = $client->updateApnsVoipSandboxChannel([
    'APNSVoipSandboxChannelRequest' => [ // REQUIRED
        'BundleId' => '<string>',
        'Certificate' => '<string>',
        'DefaultAuthenticationMethod' => '<string>',
        'Enabled' => true || false,
        'PrivateKey' => '<string>',
        'TeamId' => '<string>',
        'TokenKey' => '<string>',
        'TokenKeyId' => '<string>',
    ],
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

APNSVoipSandboxChannelRequest

: Required: Yes
: Type: APNSVoipSandboxChannelRequest structure

Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

ApplicationId

: Required: Yes
: Type: string

Result 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' => <integer>,
    ],
]

Result Details

Members

APNSVoipSandboxChannelResponse

: Required: Yes
: Type: APNSVoipSandboxChannelResponse structure

Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateApplicationSettings

$result = $client->updateApplicationSettings([/* ... */]);
$promise = $client->updateApplicationSettingsAsync([/* ... */]);

Updates the settings for an application.

Parameter Syntax

$result = $client->updateApplicationSettings([
    'ApplicationId' => '<string>', // REQUIRED
    'WriteApplicationSettingsRequest' => [ // REQUIRED
        'CampaignHook' => [
            'LambdaFunctionName' => '<string>',
            'Mode' => 'DELIVERY|FILTER',
            'WebUrl' => '<string>',
        ],
        'CloudWatchMetricsEnabled' => true || false,
        'JourneyLimits' => [
            'DailyCap' => <integer>,
            'TimeframeCap' => [
                'Cap' => <integer>,
                'Days' => <integer>,
            ],
            'TotalCap' => <integer>,
        ],
        'Limits' => [
            'Daily' => <integer>,
            'MaximumDuration' => <integer>,
            'MessagesPerSecond' => <integer>,
            'Session' => <integer>,
            'Total' => <integer>,
        ],
        'QuietTime' => [
            'End' => '<string>',
            'Start' => '<string>',
        ],
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

WriteApplicationSettingsRequest

: Required: Yes
: Type: WriteApplicationSettingsRequest structure

Specifies the default settings for an application.

Result Syntax

[
    'ApplicationSettingsResource' => [
        'ApplicationId' => '<string>',
        'CampaignHook' => [
            'LambdaFunctionName' => '<string>',
            'Mode' => 'DELIVERY|FILTER',
            'WebUrl' => '<string>',
        ],
        'JourneyLimits' => [
            'DailyCap' => <integer>,
            'TimeframeCap' => [
                'Cap' => <integer>,
                'Days' => <integer>,
            ],
            'TotalCap' => <integer>,
        ],
        'LastModifiedDate' => '<string>',
        'Limits' => [
            'Daily' => <integer>,
            'MaximumDuration' => <integer>,
            'MessagesPerSecond' => <integer>,
            'Session' => <integer>,
            'Total' => <integer>,
        ],
        'QuietTime' => [
            'End' => '<string>',
            'Start' => '<string>',
        ],
    ],
]

Result Details

Members

ApplicationSettingsResource

: Required: Yes
: Type: ApplicationSettingsResource structure

Provides information about an application, including the default settings for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateBaiduChannel

$result = $client->updateBaiduChannel([/* ... */]);
$promise = $client->updateBaiduChannelAsync([/* ... */]);

Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.

Parameter Syntax

$result = $client->updateBaiduChannel([
    'ApplicationId' => '<string>', // REQUIRED
    'BaiduChannelRequest' => [ // REQUIRED
        'ApiKey' => '<string>', // REQUIRED
        'Enabled' => true || false,
        'SecretKey' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

BaiduChannelRequest

: Required: Yes
: Type: BaiduChannelRequest structure

Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

Result 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' => <integer>,
    ],
]

Result Details

Members

BaiduChannelResponse

: Required: Yes
: Type: BaiduChannelResponse structure

Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateCampaign

$result = $client->updateCampaign([/* ... */]);
$promise = $client->updateCampaignAsync([/* ... */]);

Updates the configuration and other settings for a campaign.

Parameter Syntax

$result = $client->updateCampaign([
    'ApplicationId' => '<string>', // REQUIRED
    'CampaignId' => '<string>', // REQUIRED
    'WriteCampaignRequest' => [ // REQUIRED
        'AdditionalTreatments' => [
            [
                'CustomDeliveryConfiguration' => [
                    'DeliveryUri' => '<string>', // REQUIRED
                    'EndpointTypes' => ['<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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<string>',
                    ],
                    'EmailMessage' => [
                        'Body' => '<string>',
                        'FromAddress' => '<string>',
                        'Headers' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<string>',
                    ],
                    'InAppMessage' => [
                        'Body' => '<string>',
                        'Content' => [
                            [
                                'BackgroundColor' => '<string>',
                                'BodyConfig' => [
                                    'Alignment' => 'LEFT|CENTER|RIGHT', // REQUIRED
                                    'Body' => '<string>', // REQUIRED
                                    'TextColor' => '<string>', // REQUIRED
                                ],
                                'HeaderConfig' => [
                                    'Alignment' => 'LEFT|CENTER|RIGHT', // REQUIRED
                                    'Header' => '<string>', // REQUIRED
                                    'TextColor' => '<string>', // REQUIRED
                                ],
                                'ImageUrl' => '<string>',
                                'PrimaryBtn' => [
                                    'Android' => [
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                    ],
                                    'DefaultConfig' => [
                                        'BackgroundColor' => '<string>',
                                        'BorderRadius' => <integer>,
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                        'Text' => '<string>', // REQUIRED
                                        'TextColor' => '<string>',
                                    ],
                                    'IOS' => [
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                    ],
                                    'Web' => [
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                    ],
                                ],
                                'SecondaryBtn' => [
                                    'Android' => [
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                    ],
                                    'DefaultConfig' => [
                                        'BackgroundColor' => '<string>',
                                        'BorderRadius' => <integer>,
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                        'Text' => '<string>', // REQUIRED
                                        'TextColor' => '<string>',
                                    ],
                                    'IOS' => [
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                    ],
                                    'Web' => [
                                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                        'Link' => '<string>',
                                    ],
                                ],
                            ],
                            // ...
                        ],
                        'CustomConfig' => ['<string>', ...],
                        'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
                    ],
                    'SMSMessage' => [
                        'Body' => '<string>',
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                ],
                'Schedule' => [
                    'EndTime' => '<string>',
                    'EventFilter' => [
                        'Dimensions' => [ // REQUIRED
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                // ...
                            ],
                            'EventType' => [
                                'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                'Values' => ['<string>', ...], // REQUIRED
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>', // REQUIRED
                                    'Value' => <float>, // REQUIRED
                                ],
                                // ...
                            ],
                        ],
                        'FilterType' => 'SYSTEM|ENDPOINT', // REQUIRED
                    ],
                    'Frequency' => 'ONCE|HOURLY|DAILY|WEEKLY|MONTHLY|EVENT|IN_APP_EVENT',
                    'IsLocalTime' => true || false,
                    'QuietTime' => [
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    'StartTime' => '<string>', // REQUIRED
                    'Timezone' => '<string>',
                ],
                'SizePercent' => <integer>, // REQUIRED
                'TemplateConfiguration' => [
                    'EmailTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                    'InAppTemplate' => [
                        '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>', // REQUIRED
            'EndpointTypes' => ['<string>', ...],
        ],
        'Description' => '<string>',
        'HoldoutPercent' => <integer>,
        'Hook' => [
            'LambdaFunctionName' => '<string>',
            'Mode' => 'DELIVERY|FILTER',
            'WebUrl' => '<string>',
        ],
        'IsPaused' => true || false,
        'Limits' => [
            'Daily' => <integer>,
            'MaximumDuration' => <integer>,
            'MessagesPerSecond' => <integer>,
            'Session' => <integer>,
            'Total' => <integer>,
        ],
        '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' => <integer>,
                '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' => <integer>,
                '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' => <integer>,
                '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' => <integer>,
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'EmailMessage' => [
                'Body' => '<string>',
                'FromAddress' => '<string>',
                'Headers' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<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' => <integer>,
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'InAppMessage' => [
                'Body' => '<string>',
                'Content' => [
                    [
                        'BackgroundColor' => '<string>',
                        'BodyConfig' => [
                            'Alignment' => 'LEFT|CENTER|RIGHT', // REQUIRED
                            'Body' => '<string>', // REQUIRED
                            'TextColor' => '<string>', // REQUIRED
                        ],
                        'HeaderConfig' => [
                            'Alignment' => 'LEFT|CENTER|RIGHT', // REQUIRED
                            'Header' => '<string>', // REQUIRED
                            'TextColor' => '<string>', // REQUIRED
                        ],
                        'ImageUrl' => '<string>',
                        'PrimaryBtn' => [
                            'Android' => [
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                            ],
                            'DefaultConfig' => [
                                'BackgroundColor' => '<string>',
                                'BorderRadius' => <integer>,
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                                'Text' => '<string>', // REQUIRED
                                'TextColor' => '<string>',
                            ],
                            'IOS' => [
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                            ],
                            'Web' => [
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                            ],
                        ],
                        'SecondaryBtn' => [
                            'Android' => [
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                            ],
                            'DefaultConfig' => [
                                'BackgroundColor' => '<string>',
                                'BorderRadius' => <integer>,
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                                'Text' => '<string>', // REQUIRED
                                'TextColor' => '<string>',
                            ],
                            'IOS' => [
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                            ],
                            'Web' => [
                                'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                                'Link' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
                'CustomConfig' => ['<string>', ...],
                'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
            ],
            'SMSMessage' => [
                'Body' => '<string>',
                'EntityId' => '<string>',
                'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                'OriginationNumber' => '<string>',
                'SenderId' => '<string>',
                'TemplateId' => '<string>',
            ],
        ],
        'Name' => '<string>',
        'Priority' => <integer>,
        'Schedule' => [
            'EndTime' => '<string>',
            'EventFilter' => [
                'Dimensions' => [ // REQUIRED
                    'Attributes' => [
                        '<__string>' => [
                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                            'Values' => ['<string>', ...], // REQUIRED
                        ],
                        // ...
                    ],
                    'EventType' => [
                        'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                        'Values' => ['<string>', ...], // REQUIRED
                    ],
                    'Metrics' => [
                        '<__string>' => [
                            'ComparisonOperator' => '<string>', // REQUIRED
                            'Value' => <float>, // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'FilterType' => 'SYSTEM|ENDPOINT', // REQUIRED
            ],
            'Frequency' => 'ONCE|HOURLY|DAILY|WEEKLY|MONTHLY|EVENT|IN_APP_EVENT',
            'IsLocalTime' => true || false,
            'QuietTime' => [
                'End' => '<string>',
                'Start' => '<string>',
            ],
            'StartTime' => '<string>', // REQUIRED
            'Timezone' => '<string>',
        ],
        'SegmentId' => '<string>',
        'SegmentVersion' => <integer>,
        'TemplateConfiguration' => [
            'EmailTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'InAppTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'PushTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'SMSTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'VoiceTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
        ],
        'TreatmentDescription' => '<string>',
        'TreatmentName' => '<string>',
        'tags' => ['<string>', ...],
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

CampaignId

: Required: Yes
: Type: string

WriteCampaignRequest

: Required: Yes
: Type: WriteCampaignRequest structure

Specifies the configuration and other settings for a campaign.

Result Syntax

[
    'CampaignResponse' => [
        'AdditionalTreatments' => [
            [
                'CustomDeliveryConfiguration' => [
                    'DeliveryUri' => '<string>',
                    'EndpointTypes' => ['<string>', ...],
                ],
                '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        '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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<string>',
                    ],
                    'EmailMessage' => [
                        'Body' => '<string>',
                        'FromAddress' => '<string>',
                        'Headers' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<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' => <integer>,
                        'Title' => '<string>',
                        'Url' => '<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' => <integer>,
                                        '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' => <integer>,
                                        '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>', ...],
                        'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
                    ],
                    'SMSMessage' => [
                        'Body' => '<string>',
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                ],
                'Schedule' => [
                    'EndTime' => '<string>',
                    'EventFilter' => [
                        'Dimensions' => [
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'EventType' => [
                                'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                'Values' => ['<string>', ...],
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>',
                                    'Value' => <float>,
                                ],
                                // ...
                            ],
                        ],
                        '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' => <integer>,
                'State' => [
                    'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
                ],
                'TemplateConfiguration' => [
                    'EmailTemplate' => [
                        'Name' => '<string>',
                        'Version' => '<string>',
                    ],
                    'InAppTemplate' => [
                        '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' => ['<string>', ...],
        ],
        'DefaultState' => [
            'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
        ],
        'Description' => '<string>',
        'HoldoutPercent' => <integer>,
        'Hook' => [
            'LambdaFunctionName' => '<string>',
            'Mode' => 'DELIVERY|FILTER',
            'WebUrl' => '<string>',
        ],
        'Id' => '<string>',
        'IsPaused' => true || false,
        'LastModifiedDate' => '<string>',
        'Limits' => [
            'Daily' => <integer>,
            'MaximumDuration' => <integer>,
            'MessagesPerSecond' => <integer>,
            'Session' => <integer>,
            'Total' => <integer>,
        ],
        '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' => <integer>,
                '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' => <integer>,
                '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' => <integer>,
                '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' => <integer>,
                'Title' => '<string>',
                'Url' => '<string>',
            ],
            'EmailMessage' => [
                'Body' => '<string>',
                'FromAddress' => '<string>',
                'Headers' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<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' => <integer>,
                'Title' => '<string>',
                'Url' => '<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' => <integer>,
                                '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' => <integer>,
                                '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>', ...],
                'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
            ],
            'SMSMessage' => [
                'Body' => '<string>',
                'EntityId' => '<string>',
                'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                'OriginationNumber' => '<string>',
                'SenderId' => '<string>',
                'TemplateId' => '<string>',
            ],
        ],
        'Name' => '<string>',
        'Priority' => <integer>,
        'Schedule' => [
            'EndTime' => '<string>',
            'EventFilter' => [
                'Dimensions' => [
                    'Attributes' => [
                        '<__string>' => [
                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                            'Values' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'EventType' => [
                        'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                        'Values' => ['<string>', ...],
                    ],
                    'Metrics' => [
                        '<__string>' => [
                            'ComparisonOperator' => '<string>',
                            'Value' => <float>,
                        ],
                        // ...
                    ],
                ],
                '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' => <integer>,
        'State' => [
            'CampaignStatus' => 'SCHEDULED|EXECUTING|PENDING_NEXT_RUN|COMPLETED|PAUSED|DELETED|INVALID',
        ],
        'TemplateConfiguration' => [
            'EmailTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'InAppTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'PushTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'SMSTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
            'VoiceTemplate' => [
                'Name' => '<string>',
                'Version' => '<string>',
            ],
        ],
        'TreatmentDescription' => '<string>',
        'TreatmentName' => '<string>',
        'Version' => <integer>,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

CampaignResponse

: Required: Yes
: Type: CampaignResponse structure

Provides information about the status, configuration, and other settings for a campaign.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateEmailChannel

$result = $client->updateEmailChannel([/* ... */]);
$promise = $client->updateEmailChannelAsync([/* ... */]);

Enables the email channel for an application or updates the status and settings of the email channel for an application.

Parameter Syntax

$result = $client->updateEmailChannel([
    'ApplicationId' => '<string>', // REQUIRED
    'EmailChannelRequest' => [ // REQUIRED
        'ConfigurationSet' => '<string>',
        'Enabled' => true || false,
        'FromAddress' => '<string>', // REQUIRED
        'Identity' => '<string>', // REQUIRED
        'OrchestrationSendingRoleArn' => '<string>',
        'RoleArn' => '<string>',
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

EmailChannelRequest

: Required: Yes
: Type: EmailChannelRequest structure

Specifies the status and settings of the email channel for an application.

Result 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' => <integer>,
        'OrchestrationSendingRoleArn' => '<string>',
        'Platform' => '<string>',
        'RoleArn' => '<string>',
        'Version' => <integer>,
    ],
]

Result Details

Members

EmailChannelResponse

: Required: Yes
: Type: EmailChannelResponse structure

Provides information about the status and settings of the email channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateEmailTemplate

$result = $client->updateEmailTemplate([/* ... */]);
$promise = $client->updateEmailTemplateAsync([/* ... */]);

Updates an existing message template for messages that are sent through the email channel.

Parameter Syntax

$result = $client->updateEmailTemplate([
    'CreateNewVersion' => true || false,
    'EmailTemplateRequest' => [ // REQUIRED
        'DefaultSubstitutions' => '<string>',
        'Headers' => [
            [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'HtmlPart' => '<string>',
        'RecommenderId' => '<string>',
        'Subject' => '<string>',
        'TemplateDescription' => '<string>',
        'TextPart' => '<string>',
        'tags' => ['<string>', ...],
    ],
    'TemplateName' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members

CreateNewVersion

: Type: boolean

EmailTemplateRequest

: Required: Yes
: Type: EmailTemplateRequest structure

Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.

TemplateName

: Required: Yes
: Type: string

Version

: Type: string

Result Syntax

[
    'MessageBody' => [
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

MessageBody

: Required: Yes
: Type: MessageBody structure

Provides information about an API request or response.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateGcmChannel

$result = $client->updateGcmChannel([/* ... */]);
$promise = $client->updateGcmChannelAsync([/* ... */]);

Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

Parameter Syntax

$result = $client->updateGcmChannel([
    'ApplicationId' => '<string>', // REQUIRED
    'GCMChannelRequest' => [ // REQUIRED
        'ApiKey' => '<string>',
        'DefaultAuthenticationMethod' => '<string>',
        'Enabled' => true || false,
        'ServiceJson' => '<string>',
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

GCMChannelRequest

: Required: Yes
: Type: GCMChannelRequest structure

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.

Result Syntax

[
    'GCMChannelResponse' => [
        'ApplicationId' => '<string>',
        'CreationDate' => '<string>',
        'Credential' => '<string>',
        'DefaultAuthenticationMethod' => '<string>',
        'Enabled' => true || false,
        'HasCredential' => true || false,
        'HasFcmServiceCredentials' => true || false,
        'Id' => '<string>',
        'IsArchived' => true || false,
        'LastModifiedBy' => '<string>',
        'LastModifiedDate' => '<string>',
        'Platform' => '<string>',
        'Version' => <integer>,
    ],
]

Result Details

Members

GCMChannelResponse

: Required: Yes
: Type: GCMChannelResponse structure

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateInAppTemplate

$result = $client->updateInAppTemplate([/* ... */]);
$promise = $client->updateInAppTemplateAsync([/* ... */]);

Updates an existing message template for messages sent through the in-app message channel.

Parameter Syntax

$result = $client->updateInAppTemplate([
    'CreateNewVersion' => true || false,
    'InAppTemplateRequest' => [ // REQUIRED
        'Content' => [
            [
                'BackgroundColor' => '<string>',
                'BodyConfig' => [
                    'Alignment' => 'LEFT|CENTER|RIGHT', // REQUIRED
                    'Body' => '<string>', // REQUIRED
                    'TextColor' => '<string>', // REQUIRED
                ],
                'HeaderConfig' => [
                    'Alignment' => 'LEFT|CENTER|RIGHT', // REQUIRED
                    'Header' => '<string>', // REQUIRED
                    'TextColor' => '<string>', // REQUIRED
                ],
                'ImageUrl' => '<string>',
                'PrimaryBtn' => [
                    'Android' => [
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                    ],
                    'DefaultConfig' => [
                        'BackgroundColor' => '<string>',
                        'BorderRadius' => <integer>,
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                        'Text' => '<string>', // REQUIRED
                        'TextColor' => '<string>',
                    ],
                    'IOS' => [
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                    ],
                    'Web' => [
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                    ],
                ],
                'SecondaryBtn' => [
                    'Android' => [
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                    ],
                    'DefaultConfig' => [
                        'BackgroundColor' => '<string>',
                        'BorderRadius' => <integer>,
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                        'Text' => '<string>', // REQUIRED
                        'TextColor' => '<string>',
                    ],
                    'IOS' => [
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                    ],
                    'Web' => [
                        'ButtonAction' => 'LINK|DEEP_LINK|CLOSE', // REQUIRED
                        'Link' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'CustomConfig' => ['<string>', ...],
        'Layout' => 'BOTTOM_BANNER|TOP_BANNER|OVERLAYS|MOBILE_FEED|MIDDLE_BANNER|CAROUSEL',
        'TemplateDescription' => '<string>',
        'tags' => ['<string>', ...],
    ],
    'TemplateName' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members

CreateNewVersion

: Type: boolean

InAppTemplateRequest

: Required: Yes
: Type: InAppTemplateRequest structure

In-App Template Request.

TemplateName

: Required: Yes
: Type: string

Version

: Type: string

Result Syntax

[
    'MessageBody' => [
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

MessageBody

: Required: Yes
: Type: MessageBody structure

Provides information about an API request or response.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateJourney

$result = $client->updateJourney([/* ... */]);
$promise = $client->updateJourneyAsync([/* ... */]);

Updates the configuration and other settings for a journey.

Parameter Syntax

$result = $client->updateJourney([
    'ApplicationId' => '<string>', // REQUIRED
    'JourneyId' => '<string>', // REQUIRED
    'WriteJourneyRequest' => [ // REQUIRED
        'Activities' => [
            '<__string>' => [
                'CUSTOM' => [
                    'DeliveryUri' => '<string>',
                    'EndpointTypes' => ['<string>', ...],
                    'MessageConfig' => [
                        'Data' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'ConditionalSplit' => [
                    'Condition' => [
                        'Conditions' => [
                            [
                                'EventCondition' => [
                                    'Dimensions' => [
                                        'Attributes' => [
                                            '<__string>' => [
                                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                'Values' => ['<string>', ...], // REQUIRED
                                            ],
                                            // ...
                                        ],
                                        'EventType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Metrics' => [
                                            '<__string>' => [
                                                'ComparisonOperator' => '<string>', // REQUIRED
                                                'Value' => <float>, // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'MessageActivity' => '<string>',
                                ],
                                'SegmentCondition' => [
                                    'SegmentId' => '<string>', // REQUIRED
                                ],
                                'SegmentDimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'Behavior' => [
                                        'Recency' => [
                                            'Duration' => 'HR_24|DAY_7|DAY_14|DAY_30', // REQUIRED
                                            'RecencyType' => 'ACTIVE|INACTIVE', // REQUIRED
                                        ],
                                    ],
                                    'Demographic' => [
                                        'AppVersion' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Channel' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'DeviceType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Make' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Model' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Platform' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                    ],
                                    'Location' => [
                                        'Country' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'GPSPoint' => [
                                            'Coordinates' => [ // REQUIRED
                                                'Latitude' => <float>, // REQUIRED
                                                'Longitude' => <float>, // REQUIRED
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>', // REQUIRED
                                            'Value' => <float>, // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            // ...
                        ],
                        'Operator' => 'ALL|ANY',
                    ],
                    'EvaluationWaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                    'FalseActivity' => '<string>',
                    'TrueActivity' => '<string>',
                ],
                'ContactCenter' => [
                    'NextActivity' => '<string>',
                ],
                'Description' => '<string>',
                'EMAIL' => [
                    'MessageConfig' => [
                        'FromAddress' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'Holdout' => [
                    'NextActivity' => '<string>',
                    'Percentage' => <integer>, // REQUIRED
                ],
                'MultiCondition' => [
                    'Branches' => [
                        [
                            'Condition' => [
                                'EventCondition' => [
                                    'Dimensions' => [
                                        'Attributes' => [
                                            '<__string>' => [
                                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                'Values' => ['<string>', ...], // REQUIRED
                                            ],
                                            // ...
                                        ],
                                        'EventType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Metrics' => [
                                            '<__string>' => [
                                                'ComparisonOperator' => '<string>', // REQUIRED
                                                'Value' => <float>, // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'MessageActivity' => '<string>',
                                ],
                                'SegmentCondition' => [
                                    'SegmentId' => '<string>', // REQUIRED
                                ],
                                'SegmentDimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'Behavior' => [
                                        'Recency' => [
                                            'Duration' => 'HR_24|DAY_7|DAY_14|DAY_30', // REQUIRED
                                            'RecencyType' => 'ACTIVE|INACTIVE', // REQUIRED
                                        ],
                                    ],
                                    'Demographic' => [
                                        'AppVersion' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Channel' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'DeviceType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Make' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Model' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'Platform' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                    ],
                                    'Location' => [
                                        'Country' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        'GPSPoint' => [
                                            'Coordinates' => [ // REQUIRED
                                                'Latitude' => <float>, // REQUIRED
                                                'Longitude' => <float>, // REQUIRED
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>', // REQUIRED
                                            'Value' => <float>, // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...], // REQUIRED
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            'NextActivity' => '<string>',
                        ],
                        // ...
                    ],
                    'DefaultActivity' => '<string>',
                    'EvaluationWaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                ],
                'PUSH' => [
                    'MessageConfig' => [
                        'TimeToLive' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'RandomSplit' => [
                    'Branches' => [
                        [
                            'NextActivity' => '<string>',
                            'Percentage' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'SMS' => [
                    'MessageConfig' => [
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'Wait' => [
                    'NextActivity' => '<string>',
                    'WaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'ClosedDays' => [
            'CUSTOM' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'EMAIL' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'PUSH' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'SMS' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'VOICE' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
        ],
        'CreationDate' => '<string>',
        'JourneyChannelSettings' => [
            'ConnectCampaignArn' => '<string>',
            'ConnectCampaignExecutionRoleArn' => '<string>',
        ],
        'LastModifiedDate' => '<string>',
        'Limits' => [
            'DailyCap' => <integer>,
            'EndpointReentryCap' => <integer>,
            'EndpointReentryInterval' => '<string>',
            'MessagesPerSecond' => <integer>,
            'TimeframeCap' => [
                'Cap' => <integer>,
                'Days' => <integer>,
            ],
            'TotalCap' => <integer>,
        ],
        'LocalTime' => true || false,
        'Name' => '<string>', // REQUIRED
        'OpenHours' => [
            'CUSTOM' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'EMAIL' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'PUSH' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'SMS' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'VOICE' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
        ],
        'QuietTime' => [
            'End' => '<string>',
            'Start' => '<string>',
        ],
        'RefreshFrequency' => '<string>',
        'RefreshOnSegmentUpdate' => true || false,
        'Schedule' => [
            'EndTime' => <integer || string || DateTime>,
            'StartTime' => <integer || string || DateTime>,
            'Timezone' => '<string>',
        ],
        'SendingSchedule' => true || false,
        'StartActivity' => '<string>',
        'StartCondition' => [
            'Description' => '<string>',
            'EventStartCondition' => [
                'EventFilter' => [
                    'Dimensions' => [ // REQUIRED
                        'Attributes' => [
                            '<__string>' => [
                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                'Values' => ['<string>', ...], // REQUIRED
                            ],
                            // ...
                        ],
                        'EventType' => [
                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                            'Values' => ['<string>', ...], // REQUIRED
                        ],
                        'Metrics' => [
                            '<__string>' => [
                                'ComparisonOperator' => '<string>', // REQUIRED
                                'Value' => <float>, // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    'FilterType' => 'SYSTEM|ENDPOINT', // REQUIRED
                ],
                'SegmentId' => '<string>',
            ],
            'SegmentStartCondition' => [
                'SegmentId' => '<string>', // REQUIRED
            ],
        ],
        'State' => 'DRAFT|ACTIVE|COMPLETED|CANCELLED|CLOSED|PAUSED',
        'TimezoneEstimationMethods' => ['<string>', ...],
        'WaitForQuietTime' => true || false,
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

JourneyId

: Required: Yes
: Type: string

WriteJourneyRequest

: Required: Yes
: Type: WriteJourneyRequest structure

Specifies the configuration and other settings for a journey.

Result Syntax

[
    'JourneyResponse' => [
        'Activities' => [
            '<__string>' => [
                'CUSTOM' => [
                    'DeliveryUri' => '<string>',
                    'EndpointTypes' => ['<string>', ...],
                    'MessageConfig' => [
                        'Data' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'ConditionalSplit' => [
                    'Condition' => [
                        'Conditions' => [
                            [
                                'EventCondition' => [
                                    'Dimensions' => [
                                        'Attributes' => [
                                            '<__string>' => [
                                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                'Values' => ['<string>', ...],
                                            ],
                                            // ...
                                        ],
                                        'EventType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...],
                                        ],
                                        'Metrics' => [
                                            '<__string>' => [
                                                'ComparisonOperator' => '<string>',
                                                'Value' => <float>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'MessageActivity' => '<string>',
                                ],
                                'SegmentCondition' => [
                                    'SegmentId' => '<string>',
                                ],
                                'SegmentDimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <float>,
                                                'Longitude' => <float>,
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>',
                                            'Value' => <float>,
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            // ...
                        ],
                        'Operator' => 'ALL|ANY',
                    ],
                    'EvaluationWaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                    'FalseActivity' => '<string>',
                    'TrueActivity' => '<string>',
                ],
                'ContactCenter' => [
                    'NextActivity' => '<string>',
                ],
                'Description' => '<string>',
                'EMAIL' => [
                    'MessageConfig' => [
                        'FromAddress' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'Holdout' => [
                    'NextActivity' => '<string>',
                    'Percentage' => <integer>,
                ],
                'MultiCondition' => [
                    'Branches' => [
                        [
                            'Condition' => [
                                'EventCondition' => [
                                    'Dimensions' => [
                                        'Attributes' => [
                                            '<__string>' => [
                                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                'Values' => ['<string>', ...],
                                            ],
                                            // ...
                                        ],
                                        'EventType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...],
                                        ],
                                        'Metrics' => [
                                            '<__string>' => [
                                                'ComparisonOperator' => '<string>',
                                                'Value' => <float>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'MessageActivity' => '<string>',
                                ],
                                'SegmentCondition' => [
                                    'SegmentId' => '<string>',
                                ],
                                'SegmentDimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <float>,
                                                'Longitude' => <float>,
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>',
                                            'Value' => <float>,
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'SMS' => [
                    'MessageConfig' => [
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'Wait' => [
                    'NextActivity' => '<string>',
                    'WaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'ApplicationId' => '<string>',
        'ClosedDays' => [
            'CUSTOM' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'EMAIL' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'PUSH' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'SMS' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'VOICE' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
        ],
        'CreationDate' => '<string>',
        'Id' => '<string>',
        'JourneyChannelSettings' => [
            'ConnectCampaignArn' => '<string>',
            'ConnectCampaignExecutionRoleArn' => '<string>',
        ],
        'LastModifiedDate' => '<string>',
        'Limits' => [
            'DailyCap' => <integer>,
            'EndpointReentryCap' => <integer>,
            'EndpointReentryInterval' => '<string>',
            'MessagesPerSecond' => <integer>,
            'TimeframeCap' => [
                'Cap' => <integer>,
                'Days' => <integer>,
            ],
            'TotalCap' => <integer>,
        ],
        'LocalTime' => true || false,
        'Name' => '<string>',
        'OpenHours' => [
            'CUSTOM' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'EMAIL' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'PUSH' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'SMS' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'VOICE' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
        ],
        'QuietTime' => [
            'End' => '<string>',
            'Start' => '<string>',
        ],
        'RefreshFrequency' => '<string>',
        'RefreshOnSegmentUpdate' => true || false,
        'Schedule' => [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
            'Timezone' => '<string>',
        ],
        'SendingSchedule' => true || false,
        'StartActivity' => '<string>',
        'StartCondition' => [
            'Description' => '<string>',
            'EventStartCondition' => [
                'EventFilter' => [
                    'Dimensions' => [
                        'Attributes' => [
                            '<__string>' => [
                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                'Values' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'EventType' => [
                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                            'Values' => ['<string>', ...],
                        ],
                        'Metrics' => [
                            '<__string>' => [
                                'ComparisonOperator' => '<string>',
                                'Value' => <float>,
                            ],
                            // ...
                        ],
                    ],
                    'FilterType' => 'SYSTEM|ENDPOINT',
                ],
                'SegmentId' => '<string>',
            ],
            'SegmentStartCondition' => [
                'SegmentId' => '<string>',
            ],
        ],
        'State' => 'DRAFT|ACTIVE|COMPLETED|CANCELLED|CLOSED|PAUSED',
        'TimezoneEstimationMethods' => ['<string>', ...],
        'WaitForQuietTime' => true || false,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

JourneyResponse

: Required: Yes
: Type: JourneyResponse structure

Provides information about the status, configuration, and other settings for a journey.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.
ConflictException:: Provides information about an API request or response.

UpdateJourneyState

$result = $client->updateJourneyState([/* ... */]);
$promise = $client->updateJourneyStateAsync([/* ... */]);

Pause, resume or cancels (stops) a journey.

Parameter Syntax

$result = $client->updateJourneyState([
    'ApplicationId' => '<string>', // REQUIRED
    'JourneyId' => '<string>', // REQUIRED
    'JourneyStateRequest' => [ // REQUIRED
        'State' => 'DRAFT|ACTIVE|COMPLETED|CANCELLED|CLOSED|PAUSED',
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

JourneyId

: Required: Yes
: Type: string

JourneyStateRequest

: Required: Yes
: Type: JourneyStateRequest structure

Changes the status of a journey.

Result Syntax

[
    'JourneyResponse' => [
        'Activities' => [
            '<__string>' => [
                'CUSTOM' => [
                    'DeliveryUri' => '<string>',
                    'EndpointTypes' => ['<string>', ...],
                    'MessageConfig' => [
                        'Data' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'ConditionalSplit' => [
                    'Condition' => [
                        'Conditions' => [
                            [
                                'EventCondition' => [
                                    'Dimensions' => [
                                        'Attributes' => [
                                            '<__string>' => [
                                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                'Values' => ['<string>', ...],
                                            ],
                                            // ...
                                        ],
                                        'EventType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...],
                                        ],
                                        'Metrics' => [
                                            '<__string>' => [
                                                'ComparisonOperator' => '<string>',
                                                'Value' => <float>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'MessageActivity' => '<string>',
                                ],
                                'SegmentCondition' => [
                                    'SegmentId' => '<string>',
                                ],
                                'SegmentDimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <float>,
                                                'Longitude' => <float>,
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>',
                                            'Value' => <float>,
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            'Values' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            // ...
                        ],
                        'Operator' => 'ALL|ANY',
                    ],
                    'EvaluationWaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                    'FalseActivity' => '<string>',
                    'TrueActivity' => '<string>',
                ],
                'ContactCenter' => [
                    'NextActivity' => '<string>',
                ],
                'Description' => '<string>',
                'EMAIL' => [
                    'MessageConfig' => [
                        'FromAddress' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'Holdout' => [
                    'NextActivity' => '<string>',
                    'Percentage' => <integer>,
                ],
                'MultiCondition' => [
                    'Branches' => [
                        [
                            'Condition' => [
                                'EventCondition' => [
                                    'Dimensions' => [
                                        'Attributes' => [
                                            '<__string>' => [
                                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                                'Values' => ['<string>', ...],
                                            ],
                                            // ...
                                        ],
                                        'EventType' => [
                                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                            'Values' => ['<string>', ...],
                                        ],
                                        'Metrics' => [
                                            '<__string>' => [
                                                'ComparisonOperator' => '<string>',
                                                'Value' => <float>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'MessageActivity' => '<string>',
                                ],
                                'SegmentCondition' => [
                                    'SegmentId' => '<string>',
                                ],
                                'SegmentDimensions' => [
                                    'Attributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <float>,
                                                'Longitude' => <float>,
                                            ],
                                            'RangeInKilometers' => <float>,
                                        ],
                                    ],
                                    'Metrics' => [
                                        '<__string>' => [
                                            'ComparisonOperator' => '<string>',
                                            'Value' => <float>,
                                        ],
                                        // ...
                                    ],
                                    'UserAttributes' => [
                                        '<__string>' => [
                                            'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                            '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' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'SMS' => [
                    'MessageConfig' => [
                        'EntityId' => '<string>',
                        'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
                        'OriginationNumber' => '<string>',
                        'SenderId' => '<string>',
                        'TemplateId' => '<string>',
                    ],
                    'NextActivity' => '<string>',
                    'TemplateName' => '<string>',
                    'TemplateVersion' => '<string>',
                ],
                'Wait' => [
                    'NextActivity' => '<string>',
                    'WaitTime' => [
                        'WaitFor' => '<string>',
                        'WaitUntil' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'ApplicationId' => '<string>',
        'ClosedDays' => [
            'CUSTOM' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'EMAIL' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'PUSH' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'SMS' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
            'VOICE' => [
                [
                    'EndDateTime' => '<string>',
                    'Name' => '<string>',
                    'StartDateTime' => '<string>',
                ],
                // ...
            ],
        ],
        'CreationDate' => '<string>',
        'Id' => '<string>',
        'JourneyChannelSettings' => [
            'ConnectCampaignArn' => '<string>',
            'ConnectCampaignExecutionRoleArn' => '<string>',
        ],
        'LastModifiedDate' => '<string>',
        'Limits' => [
            'DailyCap' => <integer>,
            'EndpointReentryCap' => <integer>,
            'EndpointReentryInterval' => '<string>',
            'MessagesPerSecond' => <integer>,
            'TimeframeCap' => [
                'Cap' => <integer>,
                'Days' => <integer>,
            ],
            'TotalCap' => <integer>,
        ],
        'LocalTime' => true || false,
        'Name' => '<string>',
        'OpenHours' => [
            'CUSTOM' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'EMAIL' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'PUSH' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'SMS' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
            'VOICE' => [
                '<DayOfWeek>' => [
                    [
                        'EndTime' => '<string>',
                        'StartTime' => '<string>',
                    ],
                    // ...
                ],
                // ...
            ],
        ],
        'QuietTime' => [
            'End' => '<string>',
            'Start' => '<string>',
        ],
        'RefreshFrequency' => '<string>',
        'RefreshOnSegmentUpdate' => true || false,
        'Schedule' => [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
            'Timezone' => '<string>',
        ],
        'SendingSchedule' => true || false,
        'StartActivity' => '<string>',
        'StartCondition' => [
            'Description' => '<string>',
            'EventStartCondition' => [
                'EventFilter' => [
                    'Dimensions' => [
                        'Attributes' => [
                            '<__string>' => [
                                'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                'Values' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'EventType' => [
                            'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                            'Values' => ['<string>', ...],
                        ],
                        'Metrics' => [
                            '<__string>' => [
                                'ComparisonOperator' => '<string>',
                                'Value' => <float>,
                            ],
                            // ...
                        ],
                    ],
                    'FilterType' => 'SYSTEM|ENDPOINT',
                ],
                'SegmentId' => '<string>',
            ],
            'SegmentStartCondition' => [
                'SegmentId' => '<string>',
            ],
        ],
        'State' => 'DRAFT|ACTIVE|COMPLETED|CANCELLED|CLOSED|PAUSED',
        'TimezoneEstimationMethods' => ['<string>', ...],
        'WaitForQuietTime' => true || false,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

JourneyResponse

: Required: Yes
: Type: JourneyResponse structure

Provides information about the status, configuration, and other settings for a journey.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdatePushTemplate

$result = $client->updatePushTemplate([/* ... */]);
$promise = $client->updatePushTemplateAsync([/* ... */]);

Updates an existing message template for messages that are sent through a push notification channel.

Parameter Syntax

$result = $client->updatePushTemplate([
    'CreateNewVersion' => true || false,
    'PushNotificationTemplateRequest' => [ // REQUIRED
        '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>',
        'TemplateDescription' => '<string>',
        'tags' => ['<string>', ...],
    ],
    'TemplateName' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members

CreateNewVersion

: Type: boolean

PushNotificationTemplateRequest

: Required: Yes
: Type: PushNotificationTemplateRequest structure

Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

TemplateName

: Required: Yes
: Type: string

Version

: Type: string

Result Syntax

[
    'MessageBody' => [
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

MessageBody

: Required: Yes
: Type: MessageBody structure

Provides information about an API request or response.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateRecommenderConfiguration

$result = $client->updateRecommenderConfiguration([/* ... */]);
$promise = $client->updateRecommenderConfigurationAsync([/* ... */]);

Updates an Amazon Pinpoint configuration for a recommender model.

Parameter Syntax

$result = $client->updateRecommenderConfiguration([
    'RecommenderId' => '<string>', // REQUIRED
    'UpdateRecommenderConfiguration' => [ // REQUIRED
        'Attributes' => ['<string>', ...],
        'Description' => '<string>',
        'Name' => '<string>',
        'RecommendationProviderIdType' => '<string>',
        'RecommendationProviderRoleArn' => '<string>', // REQUIRED
        'RecommendationProviderUri' => '<string>', // REQUIRED
        'RecommendationTransformerUri' => '<string>',
        'RecommendationsDisplayName' => '<string>',
        'RecommendationsPerMessage' => <integer>,
    ],
]);

Parameter Details

Members

RecommenderId

: Required: Yes
: Type: string

UpdateRecommenderConfiguration

: Required: Yes
: Type: UpdateRecommenderConfiguration structure

Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

Result Syntax

[
    'RecommenderConfigurationResponse' => [
        'Attributes' => ['<string>', ...],
        'CreationDate' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'LastModifiedDate' => '<string>',
        'Name' => '<string>',
        'RecommendationProviderIdType' => '<string>',
        'RecommendationProviderRoleArn' => '<string>',
        'RecommendationProviderUri' => '<string>',
        'RecommendationTransformerUri' => '<string>',
        'RecommendationsDisplayName' => '<string>',
        'RecommendationsPerMessage' => <integer>,
    ],
]

Result Details

Members

RecommenderConfigurationResponse

: Required: Yes
: Type: RecommenderConfigurationResponse structure

Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateSegment

$result = $client->updateSegment([/* ... */]);
$promise = $client->updateSegmentAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateSegment([
    'ApplicationId' => '<string>', // REQUIRED
    'SegmentId' => '<string>', // REQUIRED
    'WriteSegmentRequest' => [ // REQUIRED
        'Dimensions' => [
            'Attributes' => [
                '<__string>' => [
                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'Behavior' => [
                'Recency' => [
                    'Duration' => 'HR_24|DAY_7|DAY_14|DAY_30', // REQUIRED
                    'RecencyType' => 'ACTIVE|INACTIVE', // REQUIRED
                ],
            ],
            'Demographic' => [
                'AppVersion' => [
                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                'Channel' => [
                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                'DeviceType' => [
                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                'Make' => [
                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                'Model' => [
                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                'Platform' => [
                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
            ],
            'Location' => [
                'Country' => [
                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                'GPSPoint' => [
                    'Coordinates' => [ // REQUIRED
                        'Latitude' => <float>, // REQUIRED
                        'Longitude' => <float>, // REQUIRED
                    ],
                    'RangeInKilometers' => <float>,
                ],
            ],
            'Metrics' => [
                '<__string>' => [
                    'ComparisonOperator' => '<string>', // REQUIRED
                    'Value' => <float>, // REQUIRED
                ],
                // ...
            ],
            'UserAttributes' => [
                '<__string>' => [
                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                    'Values' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
        ],
        'Name' => '<string>',
        'SegmentGroups' => [
            'Groups' => [
                [
                    'Dimensions' => [
                        [
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                // ...
                            ],
                            'Behavior' => [
                                'Recency' => [
                                    'Duration' => 'HR_24|DAY_7|DAY_14|DAY_30', // REQUIRED
                                    'RecencyType' => 'ACTIVE|INACTIVE', // REQUIRED
                                ],
                            ],
                            'Demographic' => [
                                'AppVersion' => [
                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                'Channel' => [
                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                'DeviceType' => [
                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                'Make' => [
                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                'Model' => [
                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                'Platform' => [
                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                            ],
                            'Location' => [
                                'Country' => [
                                    'DimensionType' => 'INCLUSIVE|EXCLUSIVE',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                'GPSPoint' => [
                                    'Coordinates' => [ // REQUIRED
                                        'Latitude' => <float>, // REQUIRED
                                        'Longitude' => <float>, // REQUIRED
                                    ],
                                    'RangeInKilometers' => <float>,
                                ],
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>', // REQUIRED
                                    'Value' => <float>, // REQUIRED
                                ],
                                // ...
                            ],
                            'UserAttributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...], // REQUIRED
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'SourceSegments' => [
                        [
                            'Id' => '<string>', // REQUIRED
                            'Version' => <integer>,
                        ],
                        // ...
                    ],
                    'SourceType' => 'ALL|ANY|NONE',
                    'Type' => 'ALL|ANY|NONE',
                ],
                // ...
            ],
            'Include' => 'ALL|ANY|NONE',
        ],
        'tags' => ['<string>', ...],
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

SegmentId

: Required: Yes
: Type: string

WriteSegmentRequest

: Required: Yes
: Type: WriteSegmentRequest structure

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.

Result Syntax

[
    'SegmentResponse' => [
        'ApplicationId' => '<string>',
        'Arn' => '<string>',
        'CreationDate' => '<string>',
        'Dimensions' => [
            'Attributes' => [
                '<__string>' => [
                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                    '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' => <float>,
                        'Longitude' => <float>,
                    ],
                    'RangeInKilometers' => <float>,
                ],
            ],
            'Metrics' => [
                '<__string>' => [
                    'ComparisonOperator' => '<string>',
                    'Value' => <float>,
                ],
                // ...
            ],
            'UserAttributes' => [
                '<__string>' => [
                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'Id' => '<string>',
        'ImportDefinition' => [
            'ChannelCounts' => [<integer>, ...],
            'ExternalId' => '<string>',
            'Format' => 'CSV|JSON',
            'RoleArn' => '<string>',
            'S3Url' => '<string>',
            'Size' => <integer>,
        ],
        'LastModifiedDate' => '<string>',
        'Name' => '<string>',
        'SegmentGroups' => [
            'Groups' => [
                [
                    'Dimensions' => [
                        [
                            'Attributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    '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' => <float>,
                                        'Longitude' => <float>,
                                    ],
                                    'RangeInKilometers' => <float>,
                                ],
                            ],
                            'Metrics' => [
                                '<__string>' => [
                                    'ComparisonOperator' => '<string>',
                                    'Value' => <float>,
                                ],
                                // ...
                            ],
                            'UserAttributes' => [
                                '<__string>' => [
                                    'AttributeType' => 'INCLUSIVE|EXCLUSIVE|CONTAINS|BEFORE|AFTER|BETWEEN|ON',
                                    'Values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'SourceSegments' => [
                        [
                            'Id' => '<string>',
                            'Version' => <integer>,
                        ],
                        // ...
                    ],
                    'SourceType' => 'ALL|ANY|NONE',
                    'Type' => 'ALL|ANY|NONE',
                ],
                // ...
            ],
            'Include' => 'ALL|ANY|NONE',
        ],
        'SegmentType' => 'DIMENSIONAL|IMPORT',
        'Version' => <integer>,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

SegmentResponse

: Required: Yes
: Type: SegmentResponse structure

Provides information about the configuration, dimension, and other settings for a segment.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateSmsChannel

$result = $client->updateSmsChannel([/* ... */]);
$promise = $client->updateSmsChannelAsync([/* ... */]);

Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

Parameter Syntax

$result = $client->updateSmsChannel([
    'ApplicationId' => '<string>', // REQUIRED
    'SMSChannelRequest' => [ // REQUIRED
        'Enabled' => true || false,
        'SenderId' => '<string>',
        'ShortCode' => '<string>',
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

SMSChannelRequest

: Required: Yes
: Type: SMSChannelRequest structure

Specifies the status and settings of the SMS channel for an application.

Result Syntax

[
    'SMSChannelResponse' => [
        'ApplicationId' => '<string>',
        'CreationDate' => '<string>',
        'Enabled' => true || false,
        'HasCredential' => true || false,
        'Id' => '<string>',
        'IsArchived' => true || false,
        'LastModifiedBy' => '<string>',
        'LastModifiedDate' => '<string>',
        'Platform' => '<string>',
        'PromotionalMessagesPerSecond' => <integer>,
        'SenderId' => '<string>',
        'ShortCode' => '<string>',
        'TransactionalMessagesPerSecond' => <integer>,
        'Version' => <integer>,
    ],
]

Result Details

Members

SMSChannelResponse

: Required: Yes
: Type: SMSChannelResponse structure

Provides information about the status and settings of the SMS channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateSmsTemplate

$result = $client->updateSmsTemplate([/* ... */]);
$promise = $client->updateSmsTemplateAsync([/* ... */]);

Updates an existing message template for messages that are sent through the SMS channel.

Parameter Syntax

$result = $client->updateSmsTemplate([
    'CreateNewVersion' => true || false,
    'SMSTemplateRequest' => [ // REQUIRED
        'Body' => '<string>',
        'DefaultSubstitutions' => '<string>',
        'RecommenderId' => '<string>',
        'TemplateDescription' => '<string>',
        'tags' => ['<string>', ...],
    ],
    'TemplateName' => '<string>', // REQUIRED
    'Version' => '<string>',
]);

Parameter Details

Members

CreateNewVersion

: Type: boolean

SMSTemplateRequest

: Required: Yes
: Type: SMSTemplateRequest structure

Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

TemplateName

: Required: Yes
: Type: string

Version

: Type: string

Result Syntax

[
    'MessageBody' => [
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

MessageBody

: Required: Yes
: Type: MessageBody structure

Provides information about an API request or response.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateTemplateActiveVersion

$result = $client->updateTemplateActiveVersion([/* ... */]);
$promise = $client->updateTemplateActiveVersionAsync([/* ... */]);

Changes the status of a specific version of a message template to active.

Parameter Syntax

$result = $client->updateTemplateActiveVersion([
    'TemplateActiveVersionRequest' => [ // REQUIRED
        'Version' => '<string>',
    ],
    'TemplateName' => '<string>', // REQUIRED
    'TemplateType' => '<string>', // REQUIRED
]);

Parameter Details

Members

TemplateActiveVersionRequest

: Required: Yes
: Type: TemplateActiveVersionRequest structure

Specifies which version of a message template to use as the active version of the template.

TemplateName

: Required: Yes
: Type: string

TemplateType

: Required: Yes
: Type: string

Result Syntax

[
    'MessageBody' => [
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

MessageBody

: Required: Yes
: Type: MessageBody structure

Provides information about an API request or response.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateUserEndpoint

$result = $client->updateUserEndpoint([/* ... */]);
$promise = $client->updateUserEndpointAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateUserEndpoint([
    'ApplicationId' => '<string>', // REQUIRED
    'EndpointId' => '<string>', // REQUIRED
    'EndpointRequest' => [ // REQUIRED
        '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' => <float>,
            'Longitude' => <float>,
            'PostalCode' => '<string>',
            'Region' => '<string>',
        ],
        'Metrics' => [<float>, ...],
        'OptOut' => '<string>',
        'RequestId' => '<string>',
        'User' => [
            'UserAttributes' => [
                '<__string>' => ['<string>', ...],
                // ...
            ],
            'UserId' => '<string>',
        ],
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

EndpointId

: Required: Yes
: Type: string

EndpointRequest

: Required: Yes
: Type: EndpointRequest structure

Specifies the channel type and other settings for an endpoint.

Result Syntax

[
    'MessageBody' => [
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

MessageBody

: Required: Yes
: Type: MessageBody structure

Provides information about an API request or response.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateUserEndpointsBatch

$result = $client->updateUserEndpointsBatch([/* ... */]);
$promise = $client->updateUserEndpointsBatchAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateUserEndpointsBatch([
    'ApplicationId' => '<string>', // REQUIRED
    'EndpointBatchRequest' => [ // REQUIRED
        'Item' => [ // REQUIRED
            [
                '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' => <float>,
                    'Longitude' => <float>,
                    'PostalCode' => '<string>',
                    'Region' => '<string>',
                ],
                'Metrics' => [<float>, ...],
                'OptOut' => '<string>',
                'RequestId' => '<string>',
                'User' => [
                    'UserAttributes' => [
                        '<__string>' => ['<string>', ...],
                        // ...
                    ],
                    'UserId' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

EndpointBatchRequest

: Required: Yes
: Type: EndpointBatchRequest structure

Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.

Result Syntax

[
    'MessageBody' => [
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

MessageBody

: Required: Yes
: Type: MessageBody structure

Provides information about an API request or response.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateVoiceChannel

$result = $client->updateVoiceChannel([/* ... */]);
$promise = $client->updateVoiceChannelAsync([/* ... */]);

Enables the voice channel for an application or updates the status and settings of the voice channel for an application.

Parameter Syntax

$result = $client->updateVoiceChannel([
    'ApplicationId' => '<string>', // REQUIRED
    'VoiceChannelRequest' => [ // REQUIRED
        'Enabled' => true || false,
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

VoiceChannelRequest

: Required: Yes
: Type: VoiceChannelRequest structure

Specifies the status and settings of the voice channel for an application.

Result Syntax

[
    'VoiceChannelResponse' => [
        'ApplicationId' => '<string>',
        'CreationDate' => '<string>',
        'Enabled' => true || false,
        'HasCredential' => true || false,
        'Id' => '<string>',
        'IsArchived' => true || false,
        'LastModifiedBy' => '<string>',
        'LastModifiedDate' => '<string>',
        'Platform' => '<string>',
        'Version' => <integer>,
    ],
]

Result Details

Members

VoiceChannelResponse

: Required: Yes
: Type: VoiceChannelResponse structure

Provides information about the status and settings of the voice channel for an application.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

UpdateVoiceTemplate

$result = $client->updateVoiceTemplate([/* ... */]);
$promise = $client->updateVoiceTemplateAsync([/* ... */]);

Updates an existing message template for messages that are sent through the voice channel.

Parameter Syntax

$result = $client->updateVoiceTemplate([
    'CreateNewVersion' => true || false,
    'TemplateName' => '<string>', // REQUIRED
    'Version' => '<string>',
    'VoiceTemplateRequest' => [ // REQUIRED
        'Body' => '<string>',
        'DefaultSubstitutions' => '<string>',
        'LanguageCode' => '<string>',
        'TemplateDescription' => '<string>',
        'VoiceId' => '<string>',
        'tags' => ['<string>', ...],
    ],
]);

Parameter Details

Members

CreateNewVersion

: Type: boolean

TemplateName

: Required: Yes
: Type: string

Version

: Type: string

VoiceTemplateRequest

: Required: Yes
: Type: VoiceTemplateRequest structure

Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

Result Syntax

[
    'MessageBody' => [
        'Message' => '<string>',
        'RequestID' => '<string>',
    ],
]

Result Details

Members

MessageBody

: Required: Yes
: Type: MessageBody structure

Provides information about an API request or response.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

VerifyOTPMessage

$result = $client->verifyOTPMessage([/* ... */]);
$promise = $client->verifyOTPMessageAsync([/* ... */]);

Verify an OTP

Parameter Syntax

$result = $client->verifyOTPMessage([
    'ApplicationId' => '<string>', // REQUIRED
    'VerifyOTPMessageRequestParameters' => [ // REQUIRED
        'DestinationIdentity' => '<string>', // REQUIRED
        'Otp' => '<string>', // REQUIRED
        'ReferenceId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

ApplicationId

: Required: Yes
: Type: string

VerifyOTPMessageRequestParameters

: Required: Yes
: Type: VerifyOTPMessageRequestParameters structure

Verify OTP message request.

Result Syntax

[
    'VerificationResponse' => [
        'Valid' => true || false,
    ],
]

Result Details

Members

VerificationResponse

: Required: Yes
: Type: VerificationResponse structure

Verify OTP Message Response.

Errors

BadRequestException:: Provides information about an API request or response.
InternalServerErrorException:: Provides information about an API request or response.
PayloadTooLargeException:: Provides information about an API request or response.
ForbiddenException:: Provides information about an API request or response.
NotFoundException:: Provides information about an API request or response.
MethodNotAllowedException:: Provides information about an API request or response.
TooManyRequestsException:: Provides information about an API request or response.

Shapes

ADMChannelRequest

Description

Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.

Members

ClientId

: Required: Yes
: Type: string

The Client ID that you received from Amazon to send messages by using ADM.

ClientSecret

: Required: Yes
: Type: string

The Client Secret that you received from Amazon to send messages by using ADM.

Enabled

: Type: boolean

Specifies whether to enable the ADM channel for the application.

ADMChannelResponse

Description

Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.

Members

ApplicationId

: Type: string

The unique identifier for the application that the ADM channel applies to.

CreationDate

: Type: string

The date and time when the ADM channel was enabled.

Enabled

: Type: boolean

Specifies whether the ADM channel is enabled for the application.

HasCredential

: Type: boolean

(Not used) This property is retained only for backward compatibility.

Id

: Type: string

(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.

IsArchived

: Type: boolean

Specifies whether the ADM channel is archived.

LastModifiedBy

: Type: string

The user who last modified the ADM channel.

LastModifiedDate

: Type: string

The date and time when the ADM channel was last modified.

Platform

: Required: Yes
: Type: string

The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.

Version

: Type: int

The current version of the ADM channel.

ADMMessage

Description

Specifies the settings for a one-time message that's sent directly to an endpoint through the ADM (Amazon Device Messaging) channel.

Members

Action

: Type: string

The action to occur if the recipient taps the push notification. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

Body

: Type: string

The body of the notification message.

ConsolidationKey

: Type: string

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.

Data

: Type: Associative array of custom strings keys (__string) to strings

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.

ExpiresAfter

: Type: string

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.

IconReference

: Type: string

The icon image name of the asset saved in your app.

ImageIconUrl

: Type: string

The URL of the large icon image to display in the content view of the push notification.

ImageUrl

: Type: string

The URL of an image to display in the push notification.

MD5

: Type: string

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.

RawContent

: Type: 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

: Type: 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 or supporting phone home functionality.

SmallImageIconUrl

: Type: string

The URL of the small icon image to display in the status bar and the content view of the push notification.

Sound

: Type: string

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/.

Substitutions

: Type: Associative array of custom strings keys (__string) to stringss

The default message variables to use in the notification message. You can override the default variables with individual address variables.

Title

: Type: string

The title to display above the notification message on the recipient's device.

Url

: Type: string

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.

APNSChannelRequest

Description

Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.

Members

BundleId

: Type: string

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

Certificate

: Type: string

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

DefaultAuthenticationMethod

: Type: string

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

Enabled

: Type: boolean

Specifies whether to enable the APNs channel for the application.

PrivateKey

: Type: string

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

TeamId

: Type: string

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

TokenKey

: Type: string

The authentication key to use for APNs tokens.

TokenKeyId

: Type: string

The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

APNSChannelResponse

Description

Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.

Members

ApplicationId

: Type: string

The unique identifier for the application that the APNs channel applies to.

CreationDate

: Type: string

The date and time when the APNs channel was enabled.

DefaultAuthenticationMethod

: Type: string

The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

Enabled

: Type: boolean

Specifies whether the APNs channel is enabled for the application.

HasCredential

: Type: boolean

(Not used) This property is retained only for backward compatibility.

HasTokenKey

: Type: 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

: Type: string

(Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.

IsArchived

: Type: boolean

Specifies whether the APNs channel is archived.

LastModifiedBy

: Type: string

The user who last modified the APNs channel.

LastModifiedDate

: Type: string

The date and time when the APNs channel was last modified.

Platform

: Required: Yes
: Type: string

The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.

Version

: Type: int

The current version of the APNs channel.

APNSMessage

Description

Specifies the settings for a one-time message that's sent directly to an endpoint through the APNs (Apple Push Notification service) channel.

Members

APNSPushType

: Type: string

The type of push notification to send. Valid values are:

alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.
background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.
complication - For a notification that contains update information for an app’s complication timeline.
fileprovider - For a notification that signals changes to a File Provider extension.
mdm - For a notification that tells managed devices to contact the MDM server.
voip - For a notification that provides information about an incoming VoIP call.

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.

Action

: Type: string

The action to occur if the recipient taps the push notification. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

Badge

: Type: int

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.

Body

: Type: string

The body of the notification message.

Category

: Type: string

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.

CollapseId

: Type: string

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.

Data

: Type: Associative array of custom strings keys (__string) to strings

The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

MediaUrl

: Type: string

The URL of an image or video to display in the push notification.

PreferredAuthenticationMethod

: Type: string

The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.

Priority

: Type: string

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.

RawContent

: Type: 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.

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.

SilentPush

: Type: boolean

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.

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.

Sound

: Type: string

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.

Substitutions

: Type: Associative array of custom strings keys (__string) to stringss

The default message variables to use in the notification message. You can override these default variables with individual address variables.

ThreadId

: Type: string

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.

TimeToLive

: Type: int

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.

Title

: Type: string

The title to display above the notification message on the recipient's device.

Url

: Type: string

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.

APNSPushNotificationTemplate

Description

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.

Members

Action

: Type: string

The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

Body

: Type: string

The message body to use in push notifications that are based on the message template.

MediaUrl

: Type: string

The URL of an image or video to display in push notifications that are based on the message template.

RawContent

: Type: 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

: Type: 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

: Type: 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

: Type: 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.

APNSSandboxChannelRequest

Description

Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

Members

BundleId

: Type: string

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

Certificate

: Type: string

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.

DefaultAuthenticationMethod

: Type: string

The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.

Enabled

: Type: boolean

Specifies whether to enable the APNs sandbox channel for the application.

PrivateKey

: Type: string

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

TeamId

: Type: string

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

TokenKey

: Type: string

The authentication key to use for APNs tokens.

TokenKeyId

: Type: string

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.

APNSSandboxChannelResponse

Description

Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

Members

ApplicationId

: Type: string

The unique identifier for the application that the APNs sandbox channel applies to.

CreationDate

: Type: string

The date and time when the APNs sandbox channel was enabled.

DefaultAuthenticationMethod

: Type: string

The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

Enabled

: Type: boolean

Specifies whether the APNs sandbox channel is enabled for the application.

HasCredential

: Type: boolean

(Not used) This property is retained only for backward compatibility.

HasTokenKey

: Type: 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

: Type: string

(Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.

IsArchived

: Type: boolean

Specifies whether the APNs sandbox channel is archived.

LastModifiedBy

: Type: string

The user who last modified the APNs sandbox channel.

LastModifiedDate

: Type: string

The date and time when the APNs sandbox channel was last modified.

Platform

: Required: Yes
: Type: string

The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.

Version

: Type: int

The current version of the APNs sandbox channel.

APNSVoipChannelRequest

Description

Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

Members

BundleId

: Type: string

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

Certificate

: Type: string

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

DefaultAuthenticationMethod

: Type: string

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

Enabled

: Type: boolean

Specifies whether to enable the APNs VoIP channel for the application.

PrivateKey

: Type: string

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

TeamId

: Type: string

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

TokenKey

: Type: string

The authentication key to use for APNs tokens.

TokenKeyId

: Type: string

The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

APNSVoipChannelResponse

Description

Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

Members

ApplicationId

: Type: string

The unique identifier for the application that the APNs VoIP channel applies to.

CreationDate

: Type: string

The date and time when the APNs VoIP channel was enabled.

DefaultAuthenticationMethod

: Type: string

The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

Enabled

: Type: boolean

Specifies whether the APNs VoIP channel is enabled for the application.

HasCredential

: Type: boolean

(Not used) This property is retained only for backward compatibility.

HasTokenKey

: Type: 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

: Type: string

(Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.

IsArchived

: Type: boolean

Specifies whether the APNs VoIP channel is archived.

LastModifiedBy

: Type: string

The user who last modified the APNs VoIP channel.

LastModifiedDate

: Type: string

The date and time when the APNs VoIP channel was last modified.

Platform

: Required: Yes
: Type: string

The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.

Version

: Type: int

The current version of the APNs VoIP channel.

APNSVoipSandboxChannelRequest

Description

Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

Members

BundleId

: Type: string

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

Certificate

: Type: string

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.

DefaultAuthenticationMethod

: Type: string

The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.

Enabled

: Type: boolean

Specifies whether the APNs VoIP sandbox channel is enabled for the application.

PrivateKey

: Type: string

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

TeamId

: Type: string

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

TokenKey

: Type: string

The authentication key to use for APNs tokens.

TokenKeyId

: Type: string

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.

APNSVoipSandboxChannelResponse

Description

Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

Members

ApplicationId

: Type: string

The unique identifier for the application that the APNs VoIP sandbox channel applies to.

CreationDate

: Type: string

The date and time when the APNs VoIP sandbox channel was enabled.

DefaultAuthenticationMethod

: Type: string

The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

Enabled

: Type: boolean

Specifies whether the APNs VoIP sandbox channel is enabled for the application.

HasCredential

: Type: boolean

(Not used) This property is retained only for backward compatibility.

HasTokenKey

: Type: 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

: Type: string

(Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.

IsArchived

: Type: boolean

Specifies whether the APNs VoIP sandbox channel is archived.

LastModifiedBy

: Type: string

The user who last modified the APNs VoIP sandbox channel.

LastModifiedDate

: Type: string

The date and time when the APNs VoIP sandbox channel was last modified.

Platform

: Required: Yes
: Type: string

The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.

Version

: Type: int

The current version of the APNs VoIP sandbox channel.

ActivitiesResponse

Description

Provides information about the activities that were performed by a campaign.

Members

Item

: Required: Yes
: Type: Array of ActivityResponse structures

An array of responses, one for each activity that was performed by the campaign.

NextToken

: Type: 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.

Activity

Description

Specifies the configuration and other settings for an activity in a journey.

Members

CUSTOM

: Type: CustomMessageActivity structure

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

ConditionalSplit

: Type: ConditionalSplitActivity structure

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.

ContactCenter

: Type: ContactCenterActivity structure

The settings for a connect activity. This type of activity initiates a contact center call to participants.

Description

: Type: string

The custom description of the activity.

EMAIL

: Type: EmailMessageActivity structure

The settings for an email activity. This type of activity sends an email message to participants.

Holdout

: Type: HoldoutActivity structure

The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

MultiCondition

: Type: MultiConditionalSplitActivity structure

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.

PUSH

: Type: PushMessageActivity structure

The settings for a push notification activity. This type of activity sends a push notification to participants.

RandomSplit

: Type: RandomSplitActivity structure

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.

SMS

: Type: SMSMessageActivity structure

The settings for an SMS activity. This type of activity sends a text message to participants.

Wait

: Type: WaitActivity structure

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.

ActivityResponse

Description

Provides information about an activity that was performed by a campaign.

Members

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application that the campaign applies to.

CampaignId

: Required: Yes
: Type: string

The unique identifier for the campaign that the activity applies to.

End

: Type: string

The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.

ExecutionMetrics

: Type: Associative array of custom strings keys (__string) to strings

A JSON object that contains metrics relating to the campaign execution for this campaign activity. For information about the structure and contents of the results, see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.

Id

: Required: Yes
: Type: string

The unique identifier for the activity.

Result

: Type: string

Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

ScheduledStart

: Type: string

The scheduled start time, in ISO 8601 format, for the activity.

Start

: Type: string

The actual start time, in ISO 8601 format, of the activity.

State

: Type: string

The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

SuccessfulEndpointCount

: Type: int

The total number of endpoints that the campaign successfully delivered messages to.

TimezonesCompletedCount

: Type: int

The total number of time zones that were completed.

TimezonesTotalCount

: Type: int

The total number of unique time zones that are in the segment for the campaign.

TotalEndpointCount

: Type: int

The total number of endpoints that the campaign attempted to deliver messages to.

TreatmentId

: Type: 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.

AddressConfiguration

Description

Specifies address-based configuration settings for a message that's sent directly to an endpoint.

Members

BodyOverride

: Type: string

The message body to use instead of the default message body. This value overrides the default message body.

ChannelType

: Type: string

The channel to use when sending the message.

Context

: Type: Associative array of custom strings keys (__string) to strings

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.

RawContent

: Type: string

The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

Substitutions

: Type: Associative array of custom strings keys (__string) to stringss

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.

TitleOverride

: Type: string

The message title to use instead of the default message title. This value overrides the default message title.

AndroidPushNotificationTemplate

Description

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.

Members

Action

: Type: string

The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

Body

: Type: string

The message body to use in a push notification that's based on the message template.

ImageIconUrl

: Type: 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

: Type: string

The URL of an image to display in a push notification that's based on the message template.

RawContent

: Type: 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

: Type: 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

: Type: 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

: Type: 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

: Type: 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.

ApplicationDateRangeKpiResponse

Description

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.

Members

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application that the metric applies to.

EndTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

KpiName

: Required: Yes
: Type: 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

: Required: Yes
: Type: BaseKpiResult structure

An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

NextToken

: Type: 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

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

ApplicationResponse

Description

Provides information about an application.

Members

Arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the application.

CreationDate

: Type: string

The date and time when the Application was created.

Id

: Required: Yes
: Type: string

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Name

: Required: Yes
: Type: string

The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

tags

: Type: Associative array of custom strings keys (__string) to strings

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.

ApplicationSettingsJourneyLimits

Description

The default sending limits for journeys in the application. To override these limits and define custom limits for a specific journey, use the Journey resource.

Members

DailyCap

: Type: int

The daily number of messages that an endpoint can receive from all journeys. The maximum value is 100. If set to 0, this limit will not apply.

TimeframeCap

: Type: JourneyTimeframeCap structure

The default maximum number of messages that can be sent to an endpoint during the specified timeframe for all journeys.

TotalCap

: Type: int

The default maximum number of messages that a single journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.

ApplicationSettingsResource

Description

Provides information about an application, including the default settings for an application.

Members

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

CampaignHook

: Type: CampaignHook structure

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.

JourneyLimits

: Type: ApplicationSettingsJourneyLimits structure

The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.

LastModifiedDate

: Type: string

The date and time, in ISO 8601 format, when the application's settings were last modified.

Limits

: Type: CampaignLimits structure

The default sending limits for campaigns in the application.

QuietTime

: Type: QuietTime structure

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:

The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

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.

ApplicationsResponse

Description

Provides information about all of your applications.

Members

Item

: Type: Array of ApplicationResponse structures

An array of responses, one for each application that was returned.

NextToken

: Type: 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.

AttributeDimension

Description

Specifies attribute-based criteria for including or excluding endpoints from a segment.

Members

AttributeType

: Type: string

INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

Values

: Required: Yes
: Type: Array of strings

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.

AttributesResource

Description

Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.

Members

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application.

AttributeType

: Required: Yes
: Type: string

The type of attribute or attributes that were removed from the endpoints. Valid values are:

endpoint-custom-attributes - Custom attributes that describe endpoints.
endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints.
endpoint-user-attributes - Custom attributes that describe users.

Attributes

: Type: Array of strings

An array that specifies the names of the attributes that were removed from the endpoints.

BadRequestException

Description

Provides information about an API request or response.

Members

Message

: Type: string

RequestID

: Type: string

BaiduChannelRequest

Description

Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

Members

ApiKey

: Required: Yes
: Type: string

The API key that you received from the Baidu Cloud Push service to communicate with the service.

Enabled

: Type: boolean

Specifies whether to enable the Baidu channel for the application.

SecretKey

: Required: Yes
: Type: string

The secret key that you received from the Baidu Cloud Push service to communicate with the service.

BaiduChannelResponse

Description

Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

Members

ApplicationId

: Type: string

The unique identifier for the application that the Baidu channel applies to.

CreationDate

: Type: string

The date and time when the Baidu channel was enabled.

Credential

: Required: Yes
: Type: string

The API key that you received from the Baidu Cloud Push service to communicate with the service.

Enabled

: Type: boolean

Specifies whether the Baidu channel is enabled for the application.

HasCredential

: Type: boolean

(Not used) This property is retained only for backward compatibility.

Id

: Type: string

(Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.

IsArchived

: Type: boolean

Specifies whether the Baidu channel is archived.

LastModifiedBy

: Type: string

The user who last modified the Baidu channel.

LastModifiedDate

: Type: string

The date and time when the Baidu channel was last modified.

Platform

: Required: Yes
: Type: string

The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.

Version

: Type: int

The current version of the Baidu channel.

BaiduMessage

Description

Specifies the settings for a one-time message that's sent directly to an endpoint through the Baidu (Baidu Cloud Push) channel.

Members

Action

: Type: string

The action to occur if the recipient taps the push notification. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

Body

: Type: string

The body of the notification message.

Data

: Type: Associative array of custom strings keys (__string) to strings

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.

IconReference

: Type: string

The icon image name of the asset saved in your app.

ImageIconUrl

: Type: string

The URL of the large icon image to display in the content view of the push notification.

ImageUrl

: Type: string

The URL of an image to display in the push notification.

RawContent

: Type: 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

: Type: boolean

SmallImageIconUrl

: Type: string

The URL of the small icon image to display in the status bar and the content view of the push notification.

Sound

: Type: string

Substitutions

: Type: Associative array of custom strings keys (__string) to stringss

The default message variables to use in the notification message. You can override the default variables with individual address variables.

TimeToLive

: Type: int

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).

Title

: Type: string

The title to display above the notification message on the recipient's device.

Url

: Type: string

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.

BaseKpiResult

Description

Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

Members

Rows

: Required: Yes
: Type: Array of ResultRow structures

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.

CampaignCustomMessage

Description

Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.

Members

Data

: Type: string

The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.

CampaignDateRangeKpiResponse

Description

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.

Members

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application that the metric applies to.

CampaignId

: Required: Yes
: Type: string

The unique identifier for the campaign that the metric applies to.

EndTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

KpiName

: Required: Yes
: Type: string

KpiResult

: Required: Yes
: Type: BaseKpiResult structure

An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

NextToken

: Type: 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

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

CampaignEmailMessage

Description

Specifies the content and "From" address for an email message that's sent to recipients of a campaign.

Members

Body

: Type: string

The body of the email for recipients whose email clients don't render HTML content.

FromAddress

: Type: string

The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

Headers

: Type: Array of MessageHeader structures

The list of MessageHeaders for the email. You can have up to 15 MessageHeaders for each email.

HtmlBody

: Type: string

The body of the email, in HTML format, for recipients whose email clients render HTML content.

Title

: Type: string

The subject line, or title, of the email.

CampaignEventFilter

Description

Specifies the settings for events that cause a campaign to be sent.

Members

Dimensions

: Required: Yes
: Type: EventDimensions structure

The dimension settings of the event filter for the campaign.

FilterType

: Required: Yes
: Type: 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 (Events resource) occurs.

CampaignHook

Description

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.

Members

LambdaFunctionName

: Type: 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

: Type: string

The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:

FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.

WebUrl

: Type: string

The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

CampaignInAppMessage

Description

In-app message configuration.

Members

Body

: Type: string

The message body of the notification, the email body or the text message.

Content

: Type: Array of InAppMessageContent structures

In-app message content.

CustomConfig

: Type: Associative array of custom strings keys (__string) to strings

Custom config to be sent to client.

Layout

: Type: string

In-app message layout.

CampaignLimits

Description

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.

Members

Daily

: Type: int

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

: Type: int

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

: Type: int

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 1. The maximum value is 20,000.

Session

: Type: int

The maximum total number of messages that the campaign can send per user session.

Total

: Type: int

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.

CampaignResponse

Description

Provides information about the status, configuration, and other settings for a campaign.

Members

AdditionalTreatments

: Type: Array of TreatmentResource structures

An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application that the campaign applies to.

Arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the campaign.

CreationDate

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the campaign was created.

CustomDeliveryConfiguration

: Type: CustomDeliveryConfiguration structure

The delivery configuration settings for sending the campaign through a custom channel.

DefaultState

: Type: CampaignState structure

The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

Description

: Type: string

The custom description of the campaign.

HoldoutPercent

: Type: int

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

Hook

: Type: CampaignHook structure

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.

Id

: Required: Yes
: Type: string

The unique identifier for the campaign.

IsPaused

: Type: boolean

Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

LastModifiedDate

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the campaign was last modified.

Limits

: Type: CampaignLimits structure

The messaging limits for the campaign.

MessageConfiguration

: Type: MessageConfiguration structure

The message configuration settings for the campaign.

Name

: Type: string

The name of the campaign.

Priority

: Type: int

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

Schedule

: Type: Schedule structure

The schedule settings for the campaign.

SegmentId

: Required: Yes
: Type: string

The unique identifier for the segment that's associated with the campaign.

SegmentVersion

: Required: Yes
: Type: int

The version number of the segment that's associated with the campaign.

State

: Type: CampaignState structure

The current status of the campaign.

TemplateConfiguration

: Type: TemplateConfiguration structure

The message template that’s used for the campaign.

TreatmentDescription

: Type: string

The custom description of the default treatment for the campaign.

TreatmentName

: Type: 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

: Type: int

The version number of the campaign.

tags

: Type: Associative array of custom strings keys (__string) to strings

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.

CampaignSmsMessage

Description

Specifies the content and settings for an SMS message that's sent to recipients of a campaign.

Members

Body

: Type: string

The body of the SMS message.

EntityId

: Type: string

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

MessageType

: Type: 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

: Type: 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

: Type: string

The sender ID to display on recipients' devices when they receive the SMS message.

TemplateId

: Type: string

The template ID received from the regulatory body for sending SMS in your country.

CampaignState

Description

Provides information about the status of a campaign.

Members

CampaignStatus

: Type: 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.

CampaignsResponse

Description

Provides information about the configuration and other settings for all the campaigns that are associated with an application.

Members

Item

: Required: Yes
: Type: Array of CampaignResponse structures

An array of responses, one for each campaign that's associated with the application.

NextToken

: Type: 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.

ChannelResponse

Description

Provides information about the general settings and status of a channel for an application.

Members

ApplicationId

: Type: string

The unique identifier for the application.

CreationDate

: Type: string

The date and time, in ISO 8601 format, when the channel was enabled.

Enabled

: Type: boolean

Specifies whether the channel is enabled for the application.

HasCredential

: Type: boolean

(Not used) This property is retained only for backward compatibility.

Id

: Type: string

(Deprecated) An identifier for the channel. This property is retained only for backward compatibility.

IsArchived

: Type: boolean

Specifies whether the channel is archived.

LastModifiedBy

: Type: string

The user who last modified the channel.

LastModifiedDate

: Type: string

The date and time, in ISO 8601 format, when the channel was last modified.

Version

: Type: int

The current version of the channel.

ChannelsResponse

Description

Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.

Members

Channels

: Required: Yes
: Type: Associative array of custom strings keys (__string) to ChannelResponse structures

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.

ClosedDays

Description

The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.

Members

CUSTOM

: Type: Array of ClosedDaysRule structures

Rules for a Channel.

EMAIL

: Type: Array of ClosedDaysRule structures

Rules for a Channel.

PUSH

: Type: Array of ClosedDaysRule structures

Rules for a Channel.

SMS

: Type: Array of ClosedDaysRule structures

Rules for a Channel.

VOICE

: Type: Array of ClosedDaysRule structures

Rules for a Channel.

ClosedDaysRule

Description

Specifies the rule settings for when messages can't be sent.

Members

EndDateTime

: Type: string

End DateTime ISO 8601 format

Name

: Type: string

The name of the closed day rule.

StartDateTime

: Type: string

Start DateTime ISO 8601 format

Condition

Description

Specifies the conditions to evaluate for an activity in a journey, and how to evaluate those conditions.

Members

Conditions

: Type: Array of SimpleCondition structures

The conditions to evaluate for the activity.

Operator

: Type: 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.

ConditionalSplitActivity

Description

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.

Members

Condition

: Type: Condition structure

The conditions that define the paths for the activity, and the relationship between the conditions.

EvaluationWaitTime

: Type: WaitTime structure

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.

FalseActivity

: Type: string

The unique identifier for the activity to perform if the conditions aren't met.

TrueActivity

: Type: string

The unique identifier for the activity to perform if the conditions are met.

ConflictException

Description

Provides information about an API request or response.

Members

Message

: Type: string

RequestID

: Type: string

ContactCenterActivity

Description

The settings for a connect activity. This type of activity initiates a contact center call to participants.

Members

NextActivity

: Type: string

The unique identifier for the next activity to perform after the this activity.

CreateApplicationRequest

Description

Specifies the display name of an application and the tags to associate with the application.

Members

Name

: Required: Yes
: Type: string

The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

tags

: Type: Associative array of custom strings keys (__string) to strings

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.

CreateRecommenderConfiguration

Description

Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

Members

Attributes

: Type: Associative array of custom strings keys (__string) to strings

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:

An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

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.

Description

: Type: string

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: _ ; () , ‐.

Name

: Type: string

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 (-).

RecommendationProviderIdType

: Type: string

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:

PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

RecommendationProviderRoleArn

: Required: Yes
: Type: 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

: Required: Yes
: Type: string

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.

RecommendationTransformerUri

: Type: string

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.

RecommendationsDisplayName

: Type: string

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.

RecommendationsPerMessage

: Type: int

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.

CreateTemplateMessageBody

Description

Provides information about a request to create a message template.

Members

Arn

: Type: string

The Amazon Resource Name (ARN) of the message template that was created.

Message

: Type: string

The message that's returned from the API for the request to create the message template.

RequestID

: Type: string

The unique identifier for the request to create the message template.

CustomDeliveryConfiguration

Description

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.

Members

DeliveryUri

: Required: Yes
: Type: string

The destination to send the campaign or treatment to. This value can be one of the following:

The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

EndpointTypes

: Type: Array of strings

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.

CustomMessageActivity

Description

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

Members

DeliveryUri

: Type: string

The destination to send the campaign or treatment to. This value can be one of the following:

The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

EndpointTypes

: Type: Array of strings

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

: Type: JourneyCustomMessage structure

Specifies the message data included in a custom channel message that's sent to participants in a journey.

NextActivity

: Type: string

The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

TemplateName

: Type: 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

: Type: 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 Versions resource.

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.

DefaultButtonConfiguration

Description

Default button configuration.

Members

BackgroundColor

: Type: string

The background color of the button.

BorderRadius

: Type: int

The border radius of the button.

ButtonAction

: Required: Yes
: Type: string

Action triggered by the button.

Link

: Type: string

Button destination.

Text

: Required: Yes
: Type: string

Button text.

TextColor

: Type: string

The text color of the button.

DefaultMessage

Description

Specifies the default message for all channels.

Members

Body

: Type: string

The default body of the message.

Substitutions

: Type: Associative array of custom strings keys (__string) to stringss

The default message variables to use in the message. You can override these default variables with individual address variables.

DefaultPushNotificationMessage

Description

Specifies the default settings and content for a push notification that's sent directly to an endpoint.

Members

Action

: Type: string

The default action to occur if a recipient taps the push notification. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

Body

: Type: string

The default body of the notification message.

Data

: Type: Associative array of custom strings keys (__string) to strings

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.

SilentPush

: Type: boolean

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.

Substitutions

: Type: Associative array of custom strings keys (__string) to stringss

The default message variables to use in the notification message. You can override the default variables with individual address variables.

Title

: Type: string

The default title to display above the notification message on a recipient's device.

Url

: Type: string

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.

DefaultPushNotificationTemplate

Description

Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.

Members

Action

: Type: string

The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

Body

: Type: string

The message body to use in push notifications that are based on the message template.

Sound

: Type: string

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

: Type: 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

: Type: 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.

DirectMessageConfiguration

Description

Specifies the settings and content for the default message and any default messages that you tailored for specific channels.

Members

ADMMessage

: Type: ADMMessage structure

The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

APNSMessage

: Type: APNSMessage structure

The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

BaiduMessage

: Type: BaiduMessage structure

The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

DefaultMessage

: Type: DefaultMessage structure

The default message for all channels.

DefaultPushNotificationMessage

: Type: DefaultPushNotificationMessage structure

The default push notification message for all push notification channels.

EmailMessage

: Type: EmailMessage structure

The default message for the email channel. This message overrides the default message (DefaultMessage).

GCMMessage

: Type: GCMMessage structure

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).

SMSMessage

: Type: SMSMessage structure

The default message for the SMS channel. This message overrides the default message (DefaultMessage).

VoiceMessage

: Type: VoiceMessage structure

The default message for the voice channel. This message overrides the default message (DefaultMessage).

EmailChannelRequest

Description

Specifies the status and settings of the email channel for an application.

Members

ConfigurationSet

: Type: string

The Amazon SES configuration set that you want to apply to messages that you send through the channel.

Enabled

: Type: boolean

Specifies whether to enable the email channel for the application.

FromAddress

: Required: Yes
: Type: string

The verified email address that you want to send email from when you send email through the channel.

Identity

: Required: Yes
: Type: string

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.

OrchestrationSendingRoleArn

: Type: string

The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.

RoleArn

: Type: string

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.

EmailChannelResponse

Description

Provides information about the status and settings of the email channel for an application.

Members

ApplicationId

: Type: string

The unique identifier for the application that the email channel applies to.

ConfigurationSet

: Type: string

The Amazon SES configuration set that's applied to messages that are sent through the channel.

CreationDate

: Type: string

The date and time, in ISO 8601 format, when the email channel was enabled.

Enabled

: Type: boolean

Specifies whether the email channel is enabled for the application.

FromAddress

: Type: string

The verified email address that email is sent from when you send email through the channel.

HasCredential

: Type: boolean

(Not used) This property is retained only for backward compatibility.

Id

: Type: string

(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

Identity

: Type: 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

: Type: boolean

Specifies whether the email channel is archived.

LastModifiedBy

: Type: string

The user who last modified the email channel.

LastModifiedDate

: Type: string

The date and time, in ISO 8601 format, when the email channel was last modified.

MessagesPerSecond

: Type: int

The maximum number of emails that can be sent through the channel each second.

OrchestrationSendingRoleArn

: Type: string

The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.

Platform

: Required: Yes
: Type: string

The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

RoleArn

: Type: 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

: Type: int

The current version of the email channel.

EmailMessage

Description

Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.

Members

Body

: Type: string

The body of the email message.

FeedbackForwardingAddress

: Type: string

The email address to forward bounces and complaints to, if feedback forwarding is enabled.

FromAddress

: Type: string

The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

RawEmail

: Type: RawEmail structure

The email message, represented as a raw MIME message.

ReplyToAddresses

: Type: Array of strings

The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.

SimpleEmail

: Type: SimpleEmail structure

The email message, composed of a subject, a text part, and an HTML part.

Substitutions

: Type: Associative array of custom strings keys (__string) to stringss

The default message variables to use in the email message. You can override the default variables with individual address variables.

EmailMessageActivity

Description

Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants.

Members

MessageConfig

: Type: JourneyEmailMessage structure

Specifies the sender address for an email message that's sent to participants in the journey.

NextActivity

: Type: string

The unique identifier for the next activity to perform, after the message is sent.

TemplateName

: Type: 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

: Type: 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 Versions resource.

EmailTemplateRequest

Description

Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.

Members

DefaultSubstitutions

: Type: string

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.

Headers

: Type: Array of MessageHeader structures

The list of MessageHeaders for the email. You can have up to 15 Headers.

HtmlPart

: Type: string

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.

RecommenderId

: Type: string

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.

Subject

: Type: string

The subject line, or title, to use in email messages that are based on the message template.

TemplateDescription

: Type: string

A custom description of the message template.

TextPart

: Type: string

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.

tags

: Type: Associative array of custom strings keys (__string) to strings

As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

(Deprecated) 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.

EmailTemplateResponse

Description

Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.

Members

Arn

: Type: string

The Amazon Resource Name (ARN) of the message template.

CreationDate

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the message template was created.

DefaultSubstitutions

: Type: 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.

Headers

: Type: Array of MessageHeader structures

HtmlPart

: Type: string

The message body, in HTML format, that's used in email messages that are based on the message template.

LastModifiedDate

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the message template was last modified.

RecommenderId

: Type: string

The unique identifier for the recommender model that's used by the message template.

Subject

: Type: string

The subject line, or title, that's used in email messages that are based on the message template.

TemplateDescription

: Type: string

The custom description of the message template.

TemplateName

: Required: Yes
: Type: string

The name of the message template.

TemplateType

: Required: Yes
: Type: string

The type of channel that the message template is designed for. For an email template, this value is EMAIL.

TextPart

: Type: string

The message body, in plain text format, that's used in email messages that are based on the message template.

Version

: Type: 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.

tags

: Type: Associative array of custom strings keys (__string) to strings

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.

EndpointBatchItem

Description

Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.

Members

Address

: Type: string

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.

Attributes

: Type: Associative array of custom strings keys (__string) to stringss

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.

ChannelType

: Type: string

The channel to use when sending messages or push notifications to the endpoint.

Demographic

: Type: EndpointDemographic structure

The demographic information for the endpoint, such as the time zone and platform.

EffectiveDate

: Type: string

The date and time, in ISO 8601 format, when the endpoint was created or updated.

EndpointStatus

: Type: string

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.

Id

: Type: string

The case insensitive unique identifier for the endpoint in the context of the batch. The identifier can't contain $, { or }.

Location

: Type: EndpointLocation structure

The geographic information for the endpoint.

Metrics

: Type: Associative array of custom strings keys (__string) to doubles

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

OptOut

: Type: 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

: Type: string

The unique identifier for the request to create or update the endpoint.

User

: Type: EndpointUser structure

One or more custom attributes that describe the user who's associated with the endpoint.

EndpointBatchRequest

Description

Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.

Members

Item

: Required: Yes
: Type: Array of EndpointBatchItem structures

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.

EndpointDemographic

Description

Specifies demographic information about an endpoint, such as the applicable time zone and platform.

Members

AppVersion

: Type: string

The version of the app that's associated with the endpoint.

Locale

: Type: 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

: Type: string

The manufacturer of the endpoint device, such as apple or samsung.

Model

: Type: string

The model name or number of the endpoint device, such as iPhone or SM-G900F.

ModelVersion

: Type: string

The model version of the endpoint device.

Platform

: Type: string

The platform of the endpoint device, such as ios.

PlatformVersion

: Type: string

The platform version of the endpoint device.

Timezone

: Type: string

The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.

EndpointItemResponse

Description

Provides the status code and message that result from processing data for an endpoint.

Members

Message

: Type: string

The custom message that's returned in the response as a result of processing the endpoint data.

StatusCode

: Type: int

The status code that's returned in the response as a result of processing the endpoint data.

EndpointLocation

Description

Specifies geographic information about an endpoint.

Members

City

: Type: string

The name of the city where the endpoint is located.

Country

: Type: 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

: Type: double

The latitude coordinate of the endpoint location, rounded to one decimal place.

Longitude

: Type: double

The longitude coordinate of the endpoint location, rounded to one decimal place.

PostalCode

: Type: string

The postal or ZIP code for the area where the endpoint is located.

Region

: Type: 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.

EndpointMessageResult

Description

Provides information about the delivery status and results of sending a message directly to an endpoint.

Members

Address

: Type: string

The endpoint address that the message was delivered to.

DeliveryStatus

: Required: Yes
: Type: string

The delivery status of the message. Possible values are:

DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
UNKNOWN_FAILURE - An unknown error occurred.

MessageId

: Type: string

The unique identifier for the message that was sent.

StatusCode

: Required: Yes
: Type: int

The downstream service status code for delivering the message.

StatusMessage

: Type: string

The status message for delivering the message.

UpdatedToken

: Type: 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.

EndpointRequest

Description

Specifies the channel type and other settings for an endpoint.

Members

Address

: Type: string

Attributes

: Type: Associative array of custom strings keys (__string) to stringss

ChannelType

: Type: string

The channel to use when sending messages or push notifications to the endpoint.

Demographic

: Type: EndpointDemographic structure

The demographic information for the endpoint, such as the time zone and platform.

EffectiveDate

: Type: string

The date and time, in ISO 8601 format, when the endpoint is updated.

EndpointStatus

: Type: string

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.

Location

: Type: EndpointLocation structure

The geographic information for the endpoint.

Metrics

: Type: Associative array of custom strings keys (__string) to doubles

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

OptOut

: Type: string

RequestId

: Type: string

The unique identifier for the most recent request to update the endpoint.

User

: Type: EndpointUser structure

One or more custom attributes that describe the user who's associated with the endpoint.

EndpointResponse

Description

Provides information about the channel type and other settings for an endpoint.

Members

Address

: Type: 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

: Type: string

The unique identifier for the application that's associated with the endpoint.

Attributes

: Type: Associative array of custom strings keys (__string) to stringss

ChannelType

: Type: string

The channel that's used when sending messages or push notifications to the endpoint.

CohortId

: Type: 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

: Type: string

The date and time, in ISO 8601 format, when the endpoint was created.

Demographic

: Type: EndpointDemographic structure

The demographic information for the endpoint, such as the time zone and platform.

EffectiveDate

: Type: string

The date and time, in ISO 8601 format, when the endpoint was last updated.

EndpointStatus

: Type: 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.

Id

: Type: 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

: Type: EndpointLocation structure

The geographic information for the endpoint.

Metrics

: Type: Associative array of custom strings keys (__string) to doubles

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

OptOut

: Type: string

RequestId

: Type: string

The unique identifier for the most recent request to update the endpoint.

User

: Type: EndpointUser structure

One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

EndpointSendConfiguration

Description

Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.

Members

BodyOverride

: Type: string

The body of the message. If specified, this value overrides the default message body.

Context

: Type: Associative array of custom strings keys (__string) to strings

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.

RawContent

: Type: string

The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

Substitutions

: Type: Associative array of custom strings keys (__string) to stringss

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.

TitleOverride

: Type: string

The title or subject line of the message. If specified, this value overrides the default message title or subject line.

EndpointUser

Description

Specifies data for one or more attributes that describe the user who's associated with an endpoint.

Members

UserAttributes

: Type: Associative array of custom strings keys (__string) to stringss

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.

UserId

: Type: string

The unique identifier for the user.

EndpointsResponse

Description

Provides information about all the endpoints that are associated with a user ID.

Members

Item

: Required: Yes
: Type: Array of EndpointResponse structures

An array of responses, one for each endpoint that's associated with the user ID.

Event

Description

Specifies information about an event that reports data to Amazon Pinpoint.

Members

AppPackageName

: Type: string

The package name of the app that's recording the event.

AppTitle

: Type: string

The title of the app that's recording the event.

AppVersionCode

: Type: string

The version number of the app that's recording the event.

Attributes

: Type: Associative array of custom strings keys (__string) to strings

One or more custom attributes that are associated with the event.

ClientSdkVersion

: Type: string

The version of the SDK that's running on the client device.

EventType

: Required: Yes
: Type: string

The name of the event.

Metrics

: Type: Associative array of custom strings keys (__string) to doubles

One or more custom metrics that are associated with the event.

SdkName

: Type: string

The name of the SDK that's being used to record the event.

Session

: Type: Session structure

Information about the session in which the event occurred.

Timestamp

: Required: Yes
: Type: string

The date and time, in ISO 8601 format, when the event occurred.

EventCondition

Description

Specifies the conditions to evaluate for an event that applies to an activity in a journey.

Members

Dimensions

: Type: EventDimensions structure

The dimensions for the event filter to use for the activity.

MessageActivity

: Type: string

The message identifier (message_id) for the message to use when determining whether message events meet the condition.

EventDimensions

Description

Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.

Members

Attributes

: Type: Associative array of custom strings keys (__string) to AttributeDimension structures

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.

EventType

: Type: SetDimension structure

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.

Metrics

: Type: Associative array of custom strings keys (__string) to MetricDimension structures

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.

EventFilter

Description

Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.

Members

Dimensions

: Required: Yes
: Type: EventDimensions structure

The dimensions for the event filter to use for the campaign or the journey activity.

FilterType

: Required: Yes
: Type: 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.

EventItemResponse

Description

Provides the status code and message that result from processing an event.

Members

Message

: Type: string

A custom message that's returned in the response as a result of processing the event.

StatusCode

: Type: int

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.

EventStartCondition

Description

Specifies the settings for an event that causes a journey activity to start.

Members

EventFilter

: Type: EventFilter structure

Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.

SegmentId

: Type: string

EventStream

Description

Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

Members

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application to publish event data for.

DestinationStreamArn

: Required: Yes
: Type: 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

: Type: 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

: Type: string

The date, in ISO 8601 format, when the event stream was last modified.

LastUpdatedBy

: Type: string

The IAM user who last modified the event stream.

RoleArn

: Required: Yes
: Type: string

The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

EventsBatch

Description

Specifies a batch of endpoints and events to process.

Members

Endpoint

: Required: Yes
: Type: PublicEndpoint structure

A set of properties and attributes that are associated with the endpoint.

Events

: Required: Yes
: Type: Associative array of custom strings keys (__string) to Event structures

A set of properties that are associated with the event.

EventsRequest

Description

Specifies a batch of events to process.

Members

BatchItem

: Required: Yes
: Type: Associative array of custom strings keys (__string) to EventsBatch structures

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.

EventsResponse

Description

Provides information about endpoints and the events that they're associated with.

Members

Results

: Type: Associative array of custom strings keys (__string) to ItemResponse structures

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.

ExportJobRequest

Description

Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.

Members

RoleArn

: Required: Yes
: Type: 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 where you want to export endpoint definitions to.

S3UrlPrefix

: Required: Yes
: Type: string

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/.

SegmentId

: Type: string

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.

SegmentVersion

: Type: int

The version of the segment to export endpoint definitions from, if specified.

ExportJobResource

Description

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.

Members

RoleArn

: Required: Yes
: Type: 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

: Required: Yes
: Type: 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

: Type: 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

: Type: int

The version of the segment that the endpoint definitions were exported from.

ExportJobResponse

Description

Members

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application that's associated with the export job.

CompletedPieces

: Type: int

The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.

CompletionDate

: Type: string

The date, in ISO 8601 format, when the export job was completed.

CreationDate

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the export job was created.

Definition

: Required: Yes
: Type: ExportJobResource structure

The resource settings that apply to the export job.

FailedPieces

: Type: int

The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.

Failures

: Type: Array of strings

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

: Required: Yes
: Type: string

The unique identifier for the export job.

JobStatus

: Required: Yes
: Type: 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

: Type: int

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

: Type: int

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

: Type: int

The total number of endpoint definitions that were processed by the export job.

Type

: Required: Yes
: Type: string

The job type. This value is EXPORT for export jobs.

ExportJobsResponse

Description

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.

Members

Item

: Required: Yes
: Type: Array of ExportJobResponse structures

An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).

NextToken

: Type: 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.

ForbiddenException

Description

Provides information about an API request or response.

Members

Message

: Type: string

RequestID

: Type: string

GCMChannelRequest

Description

Members

ApiKey

: Type: 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.

DefaultAuthenticationMethod

: Type: string

The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".

Enabled

: Type: boolean

Specifies whether to enable the GCM channel for the application.

ServiceJson

: Type: string

The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. For more information see Migrate from legacy FCM APIs to HTTP v1.

GCMChannelResponse

Description

Members

ApplicationId

: Type: string

The unique identifier for the application that the GCM channel applies to.

CreationDate

: Type: string

The date and time when the GCM channel was enabled.

Credential

: Type: 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.

DefaultAuthenticationMethod

: Type: string

The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".

Enabled

: Type: boolean

Specifies whether the GCM channel is enabled for the application.

HasCredential

: Type: boolean

(Not used) This property is retained only for backward compatibility.

HasFcmServiceCredentials

: Type: boolean

Returns true if the JSON file provided by Google during registration process was used in the ServiceJson field of the request.

Id

: Type: string

(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.

IsArchived

: Type: boolean

Specifies whether the GCM channel is archived.

LastModifiedBy

: Type: string

The user who last modified the GCM channel.

LastModifiedDate

: Type: string

The date and time when the GCM channel was last modified.

Platform

: Required: Yes
: Type: string

The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.

Version

: Type: int

The current version of the GCM channel.

GCMMessage

Description

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.

Members

Action

: Type: string

The action to occur if the recipient taps the push notification. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

Body

: Type: string

The body of the notification message.

CollapseKey

: Type: string

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.

Data

: Type: Associative array of custom strings keys (__string) to strings

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.

IconReference

: Type: string

The icon image name of the asset saved in your app.

ImageIconUrl

: Type: string

The URL of the large icon image to display in the content view of the push notification.

ImageUrl

: Type: string

The URL of an image to display in the push notification.

PreferredAuthenticationMethod

: Type: string

The preferred authentication method, with valid values "KEY" or "TOKEN". If a value isn't provided then the DefaultAuthenticationMethod is used.

Priority

: Type: string

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.

RawContent

: Type: 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.

RestrictedPackageName

: Type: string

The package name of the application where registration tokens must match in order for the recipient to receive the message.

SilentPush

: Type: boolean

SmallImageIconUrl

: Type: string

The URL of the small icon image to display in the status bar and the content view of the push notification.

Sound

: Type: string

Substitutions

: Type: Associative array of custom strings keys (__string) to stringss

The default message variables to use in the notification message. You can override the default variables with individual address variables.

TimeToLive

: Type: int

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.

Title

: Type: string

The title to display above the notification message on the recipient's device.

Url

: Type: string

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.

GPSCoordinates

Description

Specifies the GPS coordinates of a location.

Members

Latitude

: Required: Yes
: Type: double

The latitude coordinate of the location.

Longitude

: Required: Yes
: Type: double

The longitude coordinate of the location.

GPSPointDimension

Description

Specifies GPS-based criteria for including or excluding endpoints from a segment.

Members

Coordinates

: Required: Yes
: Type: GPSCoordinates structure

The GPS coordinates to measure distance from.

RangeInKilometers

: Type: double

The range, in kilometers, from the GPS coordinates.

HoldoutActivity

Description

Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.

Members

NextActivity

: Type: string

The unique identifier for the next activity to perform, after performing the holdout activity.

Percentage

: Required: Yes
: Type: int

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.

ImportJobRequest

Description

Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.

Members

DefineSegment

: Type: boolean

Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.

ExternalId

: Type: 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

: Required: Yes
: Type: 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 Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

RegisterEndpoints

: Type: boolean

Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

RoleArn

: Required: Yes
: Type: 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

: Required: Yes
: Type: 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

: Type: string

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.

SegmentName

: Type: string

A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

ImportJobResource

Description

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.

Members

DefineSegment

: Type: boolean

Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.

ExternalId

: Type: string

Format

: Required: Yes
: Type: 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

: Type: boolean

Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

RoleArn

: Required: Yes
: Type: 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

: Required: Yes
: Type: string

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

: Type: 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

: Type: string

The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

ImportJobResponse

Description

Members

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application that's associated with the import job.

CompletedPieces

: Type: int

The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.

CompletionDate

: Type: string

The date, in ISO 8601 format, when the import job was completed.

CreationDate

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the import job was created.

Definition

: Required: Yes
: Type: ImportJobResource structure

The resource settings that apply to the import job.

FailedPieces

: Type: int

The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.

Failures

: Type: Array of strings

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

: Required: Yes
: Type: string

The unique identifier for the import job.

JobStatus

: Required: Yes
: Type: 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

: Type: int

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

: Type: int

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

: Type: int

The total number of endpoint definitions that were processed by the import job.

Type

: Required: Yes
: Type: string

The job type. This value is IMPORT for import jobs.

ImportJobsResponse

Description

Members

Item

: Required: Yes
: Type: Array of ImportJobResponse structures

An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).

NextToken

: Type: 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.

InAppCampaignSchedule

Members

EndDate

: Type: string

The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.

EventFilter

: Type: CampaignEventFilter structure

The event filter the SDK has to use to show the in-app message in the application.

QuietTime

: Type: QuietTime structure

Time during which the in-app message should not be shown to the user.

InAppMessage

Description

Provides all fields required for building an in-app message.

Members

Content

: Type: Array of InAppMessageContent structures

In-app message content.

CustomConfig

: Type: Associative array of custom strings keys (__string) to strings

Custom config to be sent to SDK.

Layout

: Type: string

The layout of the message.

InAppMessageBodyConfig

Description

Text config for Message Body.

Members

Alignment

: Required: Yes
: Type: string

The alignment of the text. Valid values: LEFT, CENTER, RIGHT.

Body

: Required: Yes
: Type: string

Message Body.

TextColor

: Required: Yes
: Type: string

The text color.

InAppMessageButton

Description

Button Config for an in-app message.

Members

Android

: Type: OverrideButtonConfiguration structure

Default button content.

DefaultConfig

: Type: DefaultButtonConfiguration structure

Default button content.

IOS

: Type: OverrideButtonConfiguration structure

Default button content.

Web

: Type: OverrideButtonConfiguration structure

Default button content.

InAppMessageCampaign

Members

CampaignId

: Type: string

Campaign id of the corresponding campaign.

DailyCap

: Type: int

Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.

InAppMessage

: Type: InAppMessage structure

In-app message content with all fields required for rendering an in-app message.

Priority

: Type: int

Priority of the in-app message.

Schedule

: Type: InAppCampaignSchedule structure

Schedule of the campaign.

SessionCap

: Type: int

Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.

TotalCap

: Type: int

Total cap which controls the number of times an in-app message can be shown to the endpoint.

TreatmentId

: Type: string

Treatment id of the campaign.

InAppMessageContent

Description

The configuration for the message content.

Members

BackgroundColor

: Type: string

The background color for the message.

BodyConfig

: Type: InAppMessageBodyConfig structure

The configuration for the message body.

HeaderConfig

: Type: InAppMessageHeaderConfig structure

The configuration for the message header.

ImageUrl

: Type: string

The image url for the background of message.

PrimaryBtn

: Type: InAppMessageButton structure

The first button inside the message.

SecondaryBtn

: Type: InAppMessageButton structure

The second button inside message.

InAppMessageHeaderConfig

Description

Text config for Message Header.

Members

Alignment

: Required: Yes
: Type: string

The alignment of the text. Valid values: LEFT, CENTER, RIGHT.

Header

: Required: Yes
: Type: string

Message Header.

TextColor

: Required: Yes
: Type: string

The text color.

InAppMessagesResponse

Description

Get in-app messages response object.

Members

InAppMessageCampaigns

: Type: Array of InAppMessageCampaign structures

List of targeted in-app message campaigns.

InAppTemplateRequest

Description

In-App Template Request.

Members

Content

: Type: Array of InAppMessageContent structures

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.

CustomConfig

: Type: Associative array of custom strings keys (__string) to strings

Custom config to be sent to client.

Layout

: Type: string

The layout of the message.

TemplateDescription

: Type: string

The description of the template.

tags

: Type: Associative array of custom strings keys (__string) to strings

(Deprecated) 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.

InAppTemplateResponse

Description

In-App Template Response.

Members

Arn

: Type: string

The resource arn of the template.

Content

: Type: Array of InAppMessageContent structures

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.

CreationDate

: Required: Yes
: Type: string

The creation date of the template.

CustomConfig

: Type: Associative array of custom strings keys (__string) to strings

Custom config to be sent to client.

LastModifiedDate

: Required: Yes
: Type: string

The last modified date of the template.

Layout

: Type: string

The layout of the message.

TemplateDescription

: Type: string

The description of the template.

TemplateName

: Required: Yes
: Type: string

The name of the template.

TemplateType

: Required: Yes
: Type: string

The type of channel that the message template is designed for. For an in-app message template, this value is INAPP.

Version

: Type: string

The version id of the template.

tags

: Type: Associative array of custom strings keys (__string) to strings

Tags map that contains arn and InternalId for API GW.

InternalServerErrorException

Description

Provides information about an API request or response.

Members

Message

: Type: string

RequestID

: Type: string

ItemResponse

Description

Provides information about the results of a request to create or update an endpoint that's associated with an event.

Members

EndpointItemResponse

: Type: EndpointItemResponse structure

The response that was received after the endpoint data was accepted.

EventsItemResponse

: Type: Associative array of custom strings keys (__string) to EventItemResponse structures

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.

JourneyChannelSettings

Description

The channel-specific configurations for the journey.

Members

ConnectCampaignArn

: Type: string

Amazon Resource Name (ARN) of the Connect Campaign.

ConnectCampaignExecutionRoleArn

: Type: string

IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.

JourneyCustomMessage

Description

Specifies the message content for a custom channel message that's sent to participants in a journey.

Members

Data

: Type: string

The message content that's passed to an AWS Lambda function or to a web hook.

JourneyDateRangeKpiResponse

Description

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.

Members

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application that the metric applies to.

EndTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

JourneyId

: Required: Yes
: Type: string

The unique identifier for the journey that the metric applies to.

KpiName

: Required: Yes
: Type: string

KpiResult

: Required: Yes
: Type: BaseKpiResult structure

An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

NextToken

: Type: 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

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

JourneyEmailMessage

Description

Specifies the "From" address for an email message that's sent to participants in a journey.

Members

FromAddress

: Type: 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.

JourneyExecutionActivityMetricsResponse

Description

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.

Members

ActivityType

: Required: Yes
: Type: string

The type of activity that the metric applies to. Possible values are:

CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.
HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.
MESSAGE – For an email activity, which is an activity that sends an email message to participants.
MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.
RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.
WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application that the metric applies to.

JourneyActivityId

: Required: Yes
: Type: string

The unique identifier for the activity that the metric applies to.

JourneyId

: Required: Yes
: Type: string

The unique identifier for the journey that the metric applies to.

LastEvaluatedTime

: Required: Yes
: Type: 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

: Required: Yes
: Type: Associative array of custom strings keys (__string) to strings

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.

JourneyExecutionMetricsResponse

Description

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.

Members

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application that the metric applies to.

JourneyId

: Required: Yes
: Type: string

The unique identifier for the journey that the metric applies to.

LastEvaluatedTime

: Required: Yes
: Type: string

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.

Metrics

: Required: Yes
: Type: Associative array of custom strings keys (__string) to strings

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.

JourneyLimits

Description

Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.

Members

DailyCap

: Type: int

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

: Type: int

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.

EndpointReentryInterval

: Type: string

Minimum time that must pass before an endpoint can re-enter a given journey.

MessagesPerSecond

: Type: int

The maximum number of messages that the journey can send each second.

TimeframeCap

: Type: JourneyTimeframeCap structure

The number of messages that an endpoint can receive during the specified timeframe.

TotalCap

: Type: int

The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.

JourneyPushMessage

Description

Specifies the message configuration for a push notification that's sent to participants in a journey.

Members

TimeToLive

: Type: 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.

JourneyResponse

Description

Provides information about the status, configuration, and other settings for a journey.

Members

Activities

: Type: Associative array of custom strings keys (__string) to Activity structures

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application that the journey applies to.

ClosedDays

: Type: ClosedDays structure

The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.

CreationDate

: Type: string

The date, in ISO 8601 format, when the journey was created.

Id

: Required: Yes
: Type: string

The unique identifier for the journey.

JourneyChannelSettings

: Type: JourneyChannelSettings structure

Amazon Resource Name (ARN) of the Connect Campaign.

LastModifiedDate

: Type: string

The date, in ISO 8601 format, when the journey was last modified.

Limits

: Type: JourneyLimits structure

The messaging and entry limits for the journey.

LocalTime

: Type: 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

: Required: Yes
: Type: string

The name of the journey.

OpenHours

: Type: OpenHours structure

The time when a journey can send messages. QuietTime should be configured first and SendingSchedule should be set to true.

QuietTime

: Type: QuietTime structure

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:

The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

RefreshFrequency

: Type: string

The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

RefreshOnSegmentUpdate

: Type: boolean

Indicates whether the journey participants should be refreshed when a segment is updated.

Schedule

: Type: JourneySchedule structure

The schedule settings for the journey.

SendingSchedule

: Type: boolean

Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.

StartActivity

: Type: string

The unique identifier for the first activity in the journey.

StartCondition

: Type: StartCondition structure

The segment that defines which users are participants in the journey.

State

: Type: string

The current status of the journey. Possible values are:

DRAFT - The journey is being developed and hasn't been published yet.
ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
PAUSED - The journey has been paused. Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete.
COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.

TimezoneEstimationMethods

: Type: Array of strings

An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.

PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.
POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.

POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.

WaitForQuietTime

: Type: boolean

Indicates whether endpoints in quiet hours should enter a wait activity until quiet hours have elapsed.

tags

: Type: Associative array of custom strings keys (__string) to strings

This object is not used or supported.

JourneyRunExecutionActivityMetricsResponse

Description

Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity for a particular journey run, and provides information about that query.

Members

ActivityType

: Required: Yes
: Type: string

The type of activity that the metric applies to. Possible values are:

CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.
HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.
MESSAGE – For an email activity, which is an activity that sends an email message to participants.
MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.
RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.
WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application that the metric applies to.

JourneyActivityId

: Required: Yes
: Type: string

The unique identifier for the activity that the metric applies to.

JourneyId

: Required: Yes
: Type: string

The unique identifier for the journey that the metric applies to.

LastEvaluatedTime

: Required: Yes
: Type: string

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity for this journey run and updated the data for the metric.

Metrics

: Required: Yes
: Type: Associative array of custom strings keys (__string) to strings

A JSON object that contains the results of the query. For information about the structure and contents of the results, see see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.

RunId

: Required: Yes
: Type: string

The unique identifier for the journey run that the metric applies to.

JourneyRunExecutionMetricsResponse

Description

Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey run, and provides information about that query.

Members

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application that the metric applies to.

JourneyId

: Required: Yes
: Type: string

The unique identifier for the journey that the metric applies to.

LastEvaluatedTime

: Required: Yes
: Type: string

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey run and updated the data for the metric.

Metrics

: Required: Yes
: Type: Associative array of custom strings keys (__string) to strings

A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.

RunId

: Required: Yes
: Type: string

The unique identifier for the journey run that the metric applies to.

JourneyRunResponse

Description

Provides information from a specified run of a journey.

Members

CreationTime

: Required: Yes
: Type: string

The time when the journey run was created or scheduled, in ISO 8601 format.

LastUpdateTime

: Required: Yes
: Type: string

The last time the journey run was updated, in ISO 8601 format..

RunId

: Required: Yes
: Type: string

The unique identifier for the run.

Status

: Required: Yes
: Type: string

The current status of the journey run.

JourneyRunsResponse

Description

Provides information from all runs of a journey.

Members

Item

: Required: Yes
: Type: Array of JourneyRunResponse structures

An array of responses, one for each run of the journey

NextToken

: Type: 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.

JourneySMSMessage

Description

Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

Members

EntityId

: Type: string

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

MessageType

: Type: string

OriginationNumber

: Type: string

SenderId

: Type: 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.

TemplateId

: Type: string

The template ID received from the regulatory body for sending SMS in your country.

JourneySchedule

Description

Specifies the schedule settings for a journey.

Members

EndTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

StartTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Timezone

: Type: 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.

JourneyStateRequest

Description

Changes the status of a journey.

Members

State

: Type: string

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.

JourneyTimeframeCap

Description

The number of messages that can be sent to an endpoint during the specified timeframe for all journeys.

Members

Cap

: Type: int

The maximum number of messages that all journeys can send to an endpoint during the specified timeframe. The maximum value is 100. If set to 0, this limit will not apply.

Days

: Type: int

The length of the timeframe in days. The maximum value is 30. If set to 0, this limit will not apply.

JourneysResponse

Description

Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.

Members

Item

: Required: Yes
: Type: Array of JourneyResponse structures

An array of responses, one for each journey that's associated with the application.

NextToken

: Type: 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.

ListRecommenderConfigurationsResponse

Description

Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.

Members

Item

: Required: Yes
: Type: Array of RecommenderConfigurationResponse structures

An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.

NextToken

: Type: 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.

Message

Description

Specifies the content and settings for a push notification that's sent to recipients of a campaign.

Members

Action

: Type: string

The action to occur if a recipient taps the push notification. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

Body

: Type: string

The body of the notification message. The maximum number of characters is 200.

ImageIconUrl

: Type: string

The URL of the image to display as the push-notification icon, such as the icon for the app.

ImageSmallIconUrl

: Type: 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

: Type: string

The URL of an image to display in the push notification.

JsonBody

: Type: string

The JSON payload to use for a silent push notification.

MediaUrl

: Type: string

The URL of the image or video to display in the push notification.

RawContent

: Type: 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

: Type: boolean

TimeToLive

: Type: int

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

: Type: string

The title to display above the notification message on a recipient's device.

Url

: Type: 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.

MessageBody

Description

Provides information about an API request or response.

Members

Message

: Type: string

The message that's returned from the API.

RequestID

: Type: string

The unique identifier for the request or response.

MessageConfiguration

Description

Specifies the message configuration settings for a campaign.

Members

ADMMessage

: Type: Message structure

The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

APNSMessage

: Type: Message structure

The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

BaiduMessage

: Type: Message structure

The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

CustomMessage

: Type: CampaignCustomMessage structure

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.

DefaultMessage

: Type: Message structure

The default message that the campaign sends through all the channels that are configured for the campaign.

EmailMessage

: Type: CampaignEmailMessage structure

The message that the campaign sends through the email channel. If specified, this message overrides the default message.

GCMMessage

: Type: Message structure

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.

InAppMessage

: Type: CampaignInAppMessage structure

The in-app message configuration.

SMSMessage

: Type: CampaignSmsMessage structure

The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

MessageHeader

Description

Contains the name and value pair of an email header to add to your email. You can have up to 15 MessageHeaders. A header can contain information such as the sender, receiver, route, or timestamp.

Members

Name

: Type: string

The name of the message header. The header name can contain up to 126 characters.

Value

: Type: string

The value of the message header. The header value can contain up to 870 characters, including the length of any rendered attributes. For example if you add the {CreationDate} attribute, it renders as YYYY-MM-DDTHH:MM:SS.SSSZ and is 24 characters in length.

MessageRequest

Description

Specifies the configuration and other settings for a message.

Members

Addresses

: Type: Associative array of custom strings keys (__string) to AddressConfiguration structures

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.

Context

: Type: Associative array of custom strings keys (__string) to strings

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.

Endpoints

: Type: Associative array of custom strings keys (__string) to EndpointSendConfiguration structures

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.

MessageConfiguration

: Required: Yes
: Type: DirectMessageConfiguration structure

The settings and content for the default message and any default messages that you defined for specific channels.

TemplateConfiguration

: Type: TemplateConfiguration structure

The message template to use for the message.

TraceId

: Type: string

The unique identifier for tracing the message. This identifier is visible to message recipients.

MessageResponse

Description

Provides information about the results of a request to send a message to an endpoint address.

Members

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application that was used to send the message.

EndpointResult

: Type: Associative array of custom strings keys (__string) to EndpointMessageResult structures

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.

RequestId

: Type: string

The identifier for the original request that the message was delivered for.

Result

: Type: Associative array of custom strings keys (__string) to MessageResult structures

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.

MessageResult

Description

Provides information about the results of sending a message directly to an endpoint address.

Members

DeliveryStatus

: Required: Yes
: Type: string

The delivery status of the message. Possible values are:

DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint address.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
UNKNOWN_FAILURE - An unknown error occurred.

MessageId

: Type: string

The unique identifier for the message that was sent.

StatusCode

: Required: Yes
: Type: int

The downstream service status code for delivering the message.

StatusMessage

: Type: string

The status message for delivering the message.

UpdatedToken

: Type: 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.

MethodNotAllowedException

Description

Provides information about an API request or response.

Members

Message

: Type: string

RequestID

: Type: string

MetricDimension

Description

Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

Members

ComparisonOperator

: Required: Yes
: Type: 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

: Required: Yes
: Type: double

The value to compare.

MultiConditionalBranch

Description

Specifies a condition to evaluate for an activity path in a journey.

Members

Condition

: Type: SimpleCondition structure

The condition to evaluate for the activity path.

NextActivity

: Type: string

The unique identifier for the next activity to perform, after completing the activity for the path.

MultiConditionalSplitActivity

Description

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.

Members

Branches

: Type: Array of MultiConditionalBranch structures

The paths for the activity, including the conditions for entering each path and the activity to perform for each path.

DefaultActivity

: Type: 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

: Type: WaitTime structure

The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.

NotFoundException

Description

Provides information about an API request or response.

Members

Message

: Type: string

RequestID

: Type: string

NumberValidateRequest

Description

Specifies a phone number to validate and retrieve information about.

Members

IsoCountryCode

: Type: string

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

PhoneNumber

: Type: string

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

Description

Provides information about a phone number.

Members

Carrier

: Type: string

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.

City

: Type: string

The name of the city where the phone number was originally registered.

CleansedPhoneNumberE164

: Type: string

The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.

CleansedPhoneNumberNational

: Type: string

The cleansed phone number, in the format for the location where the phone number was originally registered.

Country

: Type: string

The name of the country or region where the phone number was originally registered.

CountryCodeIso2

: Type: string

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

CountryCodeNumeric

: Type: string

The numeric code for the country or region where the phone number was originally registered.

County

: Type: string

The name of the county where the phone number was originally registered.

OriginalCountryCodeIso2

: Type: string

The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.

OriginalPhoneNumber

: Type: string

The phone number that was sent in the request body.

PhoneType

: Type: string

The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.

PhoneTypeCode

: Type: int

The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).

Timezone

: Type: string

The time zone for the location where the phone number was originally registered.

ZipCode

: Type: string

The postal or ZIP code for the location where the phone number was originally registered.

OpenHours

Description

Specifies the times when message are allowed to be sent to endpoints.

Members

CUSTOM

: Type: Associative array of custom strings keys (DayOfWeek) to OpenHoursRule structuress

Specifies the schedule settings for the custom channel.

EMAIL

: Type: Associative array of custom strings keys (DayOfWeek) to OpenHoursRule structuress

Specifies the schedule settings for the email channel.

PUSH

: Type: Associative array of custom strings keys (DayOfWeek) to OpenHoursRule structuress

Specifies the schedule settings for the push channel.

SMS

: Type: Associative array of custom strings keys (DayOfWeek) to OpenHoursRule structuress

Specifies the schedule settings for the SMS channel.

VOICE

: Type: Associative array of custom strings keys (DayOfWeek) to OpenHoursRule structuress

Specifies the schedule settings for the voice channel.

OpenHoursRule

Description

Specifies the start and end time for OpenHours.

Members

EndTime

: Type: string

The end of the scheduled time, in ISO 8601 format, when the channel can't send messages.

StartTime

: Type: string

The start of the scheduled time, in ISO 8601 format, when the channel can send messages.

OverrideButtonConfiguration

Description

Override button configuration.

Members

ButtonAction

: Required: Yes
: Type: string

Action triggered by the button.

Link

: Type: string

Button destination.

PayloadTooLargeException

Description

Provides information about an API request or response.

Members

Message

: Type: string

RequestID

: Type: string

PublicEndpoint

Description

Specifies the properties and attributes of an endpoint that's associated with an event.

Members

Address

: Type: string

The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

Attributes

: Type: Associative array of custom strings keys (__string) to stringss

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.

ChannelType

: Type: string

The channel that's used when sending messages or push notifications to the endpoint.

Demographic

: Type: EndpointDemographic structure

The demographic information for the endpoint, such as the time zone and platform.

EffectiveDate

: Type: string

The date and time, in ISO 8601 format, when the endpoint was last updated.

EndpointStatus

: Type: string

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.

Location

: Type: EndpointLocation structure

The geographic information for the endpoint.

Metrics

: Type: Associative array of custom strings keys (__string) to doubles

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

OptOut

: Type: string

RequestId

: Type: string

A unique identifier that's generated each time the endpoint is updated.

User

: Type: EndpointUser structure

One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

PushMessageActivity

Description

Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants.

Members

MessageConfig

: Type: JourneyPushMessage structure

Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

NextActivity

: Type: string

The unique identifier for the next activity to perform, after the message is sent.

TemplateName

: Type: 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

: Type: 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 Versions resource.

PushNotificationTemplateRequest

Description

Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

Members

ADM

: Type: AndroidPushNotificationTemplate structure

The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

APNS

: Type: APNSPushNotificationTemplate structure

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).

Baidu

: Type: AndroidPushNotificationTemplate structure

The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Default

: Type: DefaultPushNotificationTemplate structure

The default message template to use for push notification channels.

DefaultSubstitutions

: Type: string

GCM

: Type: AndroidPushNotificationTemplate structure

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).

RecommenderId

: Type: string

TemplateDescription

: Type: string

A custom description of the message template.

tags

: Type: Associative array of custom strings keys (__string) to strings

(Deprecated) 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.

PushNotificationTemplateResponse

Description

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.

Members

ADM

: Type: AndroidPushNotificationTemplate structure

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).

APNS

: Type: APNSPushNotificationTemplate structure

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).

Arn

: Type: string

The Amazon Resource Name (ARN) of the message template.

Baidu

: Type: AndroidPushNotificationTemplate structure

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).

CreationDate

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the message template was created.

Default

: Type: DefaultPushNotificationTemplate structure

The default message template that's used for push notification channels.

DefaultSubstitutions

: Type: string

GCM

: Type: AndroidPushNotificationTemplate structure

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).

LastModifiedDate

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the message template was last modified.

RecommenderId

: Type: string

The unique identifier for the recommender model that's used by the message template.

TemplateDescription

: Type: string

The custom description of the message template.

TemplateName

: Required: Yes
: Type: string

The name of the message template.

TemplateType

: Required: Yes
: Type: string

The type of channel that the message template is designed for. For a push notification template, this value is PUSH.

Version

: Type: 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.

tags

: Type: Associative array of custom strings keys (__string) to strings

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.

QuietTime

Description

Specifies the start and end times that define a time range when messages aren't sent to endpoints.

Members

End

: Type: 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

: Type: 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.

RandomSplitActivity

Description

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.

Members

Branches

: Type: Array of RandomSplitEntry structures

The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.

RandomSplitEntry

Description

Specifies the settings for a path in a random split activity in a journey.

Members

NextActivity

: Type: string

The unique identifier for the next activity to perform, after completing the activity for the path.

Percentage

: Type: int

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.

RawEmail

Description

Specifies the contents of an email message, represented as a raw MIME message.

Members

Data

: Type: blob (string|resource|Psr\Http\Message\StreamInterface)

RecencyDimension

Description

Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.

Members

Duration

: Required: Yes
: Type: string

The duration to use when determining whether an endpoint is active or inactive.

RecencyType

: Required: Yes
: Type: 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.

RecommenderConfigurationResponse

Description

Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

Members

Attributes

: Type: Associative array of custom strings keys (__string) to strings

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

: Required: Yes
: Type: string

The date, in extended ISO 8601 format, when the configuration was created for the recommender model.

Description

: Type: string

The custom description of the configuration for the recommender model.

Id

: Required: Yes
: Type: string

The unique identifier for the recommender model configuration.

LastModifiedDate

: Required: Yes
: Type: string

The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.

Name

: Type: string

The custom name of the configuration for the recommender model.

RecommendationProviderIdType

: Type: 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:

PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

RecommendationProviderRoleArn

: Required: Yes
: Type: 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

: Required: Yes
: Type: 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

: Type: 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

: Type: 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

: Type: int

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.

ResultRow

Description

Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

Members

GroupedBys

: Required: Yes
: Type: Array of ResultRowValue structures

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.

Values

: Required: Yes
: Type: Array of ResultRowValue structures

An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.

ResultRowValue

Description

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.

Members

Key

: Required: Yes
: Type: string

The friendly name of the metric whose value is specified by the Value property.

Type

: Required: Yes
: Type: string

The data type of the value specified by the Value property.

Value

: Required: Yes
: Type: 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).

SMSChannelRequest

Description

Specifies the status and settings of the SMS channel for an application.

Members

Enabled

: Type: boolean

Specifies whether to enable the SMS channel for the application.

SenderId

: Type: string

The identity that you want to display on recipients' devices when they receive messages from the SMS channel.

ShortCode

: Type: string

The registered short code that you want to use when you send messages through the SMS channel.

SMSChannelResponse

Description

Provides information about the status and settings of the SMS channel for an application.

Members

ApplicationId

: Type: string

The unique identifier for the application that the SMS channel applies to.

CreationDate

: Type: string

The date and time, in ISO 8601 format, when the SMS channel was enabled.

Enabled

: Type: boolean

Specifies whether the SMS channel is enabled for the application.

HasCredential

: Type: boolean

(Not used) This property is retained only for backward compatibility.

Id

: Type: string

(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

IsArchived

: Type: boolean

Specifies whether the SMS channel is archived.

LastModifiedBy

: Type: string

The user who last modified the SMS channel.

LastModifiedDate

: Type: string

The date and time, in ISO 8601 format, when the SMS channel was last modified.

Platform

: Required: Yes
: Type: string

The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

PromotionalMessagesPerSecond

: Type: int

The maximum number of promotional messages that you can send through the SMS channel each second.

SenderId

: Type: string

The identity that displays on recipients' devices when they receive messages from the SMS channel.

ShortCode

: Type: string

The registered short code to use when you send messages through the SMS channel.

TransactionalMessagesPerSecond

: Type: int

The maximum number of transactional messages that you can send through the SMS channel each second.

Version

: Type: int

The current version of the SMS channel.

SMSMessage

Description

Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.

Members

Body

: Type: string

The body of the SMS message.

EntityId

: Type: string

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

Keyword

: Type: string

The SMS program name that you provided to AWS Support when you requested your dedicated number.

MediaUrl

: Type: string

This field is reserved for future use.

MessageType

: Type: string

OriginationNumber

: Type: string

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.

SenderId

: Type: 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.

Substitutions

: Type: Associative array of custom strings keys (__string) to stringss

The message variables to use in the SMS message. You can override the default variables with individual address variables.

TemplateId

: Type: string

The template ID received from the regulatory body for sending SMS in your country.

SMSMessageActivity

Description

Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.

Members

MessageConfig

: Type: JourneySMSMessage structure

Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

NextActivity

: Type: string

The unique identifier for the next activity to perform, after the message is sent.

TemplateName

: Type: 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

: Type: 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 Versions resource.

SMSTemplateRequest

Description

Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

Members

Body

: Type: string

The message body to use in text messages that are based on the message template.

DefaultSubstitutions

: Type: string

RecommenderId

: Type: string

TemplateDescription

: Type: string

A custom description of the message template.

tags

: Type: Associative array of custom strings keys (__string) to strings

(Deprecated) 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.

SMSTemplateResponse

Description

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.

Members

Arn

: Type: string

The Amazon Resource Name (ARN) of the message template.

Body

: Type: string

The message body that's used in text messages that are based on the message template.

CreationDate

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the message template was created.

DefaultSubstitutions

: Type: string

LastModifiedDate

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the message template was last modified.

RecommenderId

: Type: string

The unique identifier for the recommender model that's used by the message template.

TemplateDescription

: Type: string

The custom description of the message template.

TemplateName

: Required: Yes
: Type: string

The name of the message template.

TemplateType

: Required: Yes
: Type: string

The type of channel that the message template is designed for. For an SMS template, this value is SMS.

Version

: Type: 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.

tags

: Type: Associative array of custom strings keys (__string) to strings

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.

Schedule

Description

Specifies the schedule settings for a campaign.

Members

EndTime

: Type: string

The scheduled time, in ISO 8601 format, when the campaign ended or will end.

EventFilter

: Type: CampaignEventFilter structure

The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

Frequency

: Type: string

Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

IsLocalTime

: Type: 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

: Type: QuietTime structure

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:

The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

StartTime

: Required: Yes
: Type: 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

: Type: 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.

SegmentBehaviors

Description

Specifies dimension settings for including or excluding endpoints from a segment based on how recently an endpoint was active.

Members

Recency

: Type: RecencyDimension structure

The dimension settings that are based on how recently an endpoint was active.

SegmentCondition

Description

Specifies a segment to associate with an activity in a journey.

Members

SegmentId

: Required: Yes
: Type: string

The unique identifier for the segment to associate with the activity.

SegmentDemographics

Description

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.

Members

AppVersion

: Type: SetDimension structure

The app version criteria for the segment.

Channel

: Type: SetDimension structure

The channel criteria for the segment.

DeviceType

: Type: SetDimension structure

The device type criteria for the segment.

Make

: Type: SetDimension structure

The device make criteria for the segment.

Model

: Type: SetDimension structure

The device model criteria for the segment.

Platform

: Type: SetDimension structure

The device platform criteria for the segment.

SegmentDimensions

Description

Specifies the dimension settings for a segment.

Members

Attributes

: Type: Associative array of custom strings keys (__string) to AttributeDimension structures

One or more custom attributes to use as criteria for the segment.

Behavior

: Type: SegmentBehaviors structure

The behavior-based criteria, such as how recently users have used your app, for the segment.

Demographic

: Type: SegmentDemographics structure

The demographic-based criteria, such as device platform, for the segment.

Location

: Type: SegmentLocation structure

The location-based criteria, such as region or GPS coordinates, for the segment.

Metrics

: Type: Associative array of custom strings keys (__string) to MetricDimension structures

One or more custom metrics to use as criteria for the segment.

UserAttributes

: Type: Associative array of custom strings keys (__string) to AttributeDimension structures

One or more custom user attributes to use as criteria for the segment.

SegmentGroup

Description

Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.

Members

Dimensions

: Type: Array of SegmentDimensions structures

An array that defines the dimensions for the segment.

SourceSegments

: Type: Array of SegmentReference structures

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.

SourceType

: Type: 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

: 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.

SegmentGroupList

Description

Specifies the settings that define the relationships between segment groups for a segment.

Members

Groups

: Type: Array of SegmentGroup structures

An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

Include

: Type: 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.

SegmentImportResource

Description

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.

Members

ChannelCounts

: Type: Associative array of custom strings keys (__string) to ints

The number of channel types in the endpoint definitions that were imported to create the segment.

ExternalId

: Required: Yes
: Type: string

Format

: Required: Yes
: Type: 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

: Required: Yes
: Type: 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

: Required: Yes
: Type: string

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

Size

: Required: Yes
: Type: int

The number of endpoint definitions that were imported successfully to create the segment.

SegmentLocation

Description

Specifies geographical dimension settings for a segment.

Members

Country

: Type: SetDimension structure

The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

GPSPoint

: Type: GPSPointDimension structure

The GPS location and range for the segment.

SegmentReference

Description

Specifies the segment identifier and version of a segment.

Members

Id

: Required: Yes
: Type: string

The unique identifier for the segment.

Version

: Type: int

The version number of the segment.

SegmentResponse

Description

Provides information about the configuration, dimension, and other settings for a segment.

Members

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application that the segment is associated with.

Arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the segment.

CreationDate

: Required: Yes
: Type: string

The date and time when the segment was created.

Dimensions

: Type: SegmentDimensions structure

The dimension settings for the segment.

Id

: Required: Yes
: Type: string

The unique identifier for the segment.

ImportDefinition

: Type: SegmentImportResource structure

The settings for the import job that's associated with the segment.

LastModifiedDate

: Type: string

The date and time when the segment was last modified.

Name

: Type: string

The name of the segment.

SegmentGroups

: Type: SegmentGroupList structure

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.

SegmentType

: Required: Yes
: Type: string

The segment type. Valid values are:

DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

Version

: Type: int

The version number of the segment.

tags

: Type: Associative array of custom strings keys (__string) to strings

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.

SegmentsResponse

Description

Provides information about all the segments that are associated with an application.

Members

Item

: Required: Yes
: Type: Array of SegmentResponse structures

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).

NextToken

: Type: 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.

SendOTPMessageRequestParameters

Description

Send OTP message request parameters.

Members

AllowedAttempts

: Type: int

The attempts allowed to validate an OTP.

BrandName

: Required: Yes
: Type: string

The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.

Channel

: Required: Yes
: Type: string

Channel type for the OTP message. Supported values: [SMS].

CodeLength

: Type: int

The number of characters in the generated OTP.

DestinationIdentity

: Required: Yes
: Type: string

The destination identity to send OTP to.

EntityId

: Type: string

A unique Entity ID received from DLT after entity registration is approved.

Language

: Type: string

The language to be used for the outgoing message body containing the OTP.

OriginationIdentity

: Required: Yes
: Type: string

The origination identity used to send OTP from.

ReferenceId

: Required: Yes
: Type: string

Developer-specified reference identifier. Required to match during OTP verification.

TemplateId

: Type: string

A unique Template ID received from DLT after entity registration is approved.

ValidityPeriod

: Type: int

The time in minutes before the OTP is no longer valid.

SendUsersMessageRequest

Description

Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.

Members

Context

: Type: Associative array of custom strings keys (__string) to strings

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.

MessageConfiguration

: Required: Yes
: Type: DirectMessageConfiguration structure

The settings and content for the default message and any default messages that you defined for specific channels.

TemplateConfiguration

: Type: TemplateConfiguration structure

The message template to use for the message.

TraceId

: Type: string

The unique identifier for tracing the message. This identifier is visible to message recipients.

Users

: Required: Yes
: Type: Associative array of custom strings keys (__string) to EndpointSendConfiguration structures

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.

SendUsersMessageResponse

Description

Provides information about which users and endpoints a message was sent to.

Members

ApplicationId

: Required: Yes
: Type: string

The unique identifier for the application that was used to send the message.

RequestId

: Type: string

The unique identifier that was assigned to the message request.

Result

: Type: Associative array of custom strings keys (__string) to EndpointMessageResult structuress

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.

Session

Description

Provides information about a session.

Members

Duration

: Type: int

The duration of the session, in milliseconds.

Id

: Required: Yes
: Type: string

The unique identifier for the session.

StartTimestamp

: Required: Yes
: Type: string

The date and time when the session began.

StopTimestamp

: Type: string

The date and time when the session ended.

SetDimension

Description

Specifies the dimension type and values for a segment dimension.

Members

DimensionType

: Type: 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

: Required: Yes
: Type: Array of strings

The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

SimpleCondition

Description

Specifies a condition to evaluate for an activity in a journey.

Members

EventCondition

: Type: EventCondition structure

The dimension settings for the event that's associated with the activity.

SegmentCondition

: Type: SegmentCondition structure

The segment that's associated with the activity.

SegmentDimensions

: Type: SegmentDimensions structure

The dimension settings for the segment that's associated with the activity.

SimpleEmail

Description

Specifies the contents of an email message, composed of a subject, a text part, and an HTML part.

Members

Headers

: Type: Array of MessageHeader structures

List of Headers for the email.

HtmlPart

: Type: SimpleEmailPart structure

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.

Subject

: Type: SimpleEmailPart structure

The subject line, or title, of the email.

TextPart

: Type: SimpleEmailPart structure

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.

SimpleEmailPart

Description

Specifies the subject or body of an email message, represented as textual email data and the applicable character set.

Members

Charset

: Type: string

The applicable character set for the message content.

Data

: Type: string

The textual data of the message content.

StartCondition

Description

Specifies the conditions for the first activity in a journey. This activity and its conditions determine which users are participants in a journey.

Members

Description

: Type: string

The custom description of the condition.

EventStartCondition

: Type: EventStartCondition structure

Specifies the settings for an event that causes a journey activity to start.

SegmentStartCondition

: Type: SegmentCondition structure

The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.

TagsModel

Description

Specifies the tags (keys and values) for an application, campaign, message template, or segment.

Members

tags

: Required: Yes
: Type: Associative array of custom strings keys (__string) to strings

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.

Template

Description

Specifies the name and version of the message template to use for the message.

Members

Name

: Type: 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

: Type: string

TemplateActiveVersionRequest

Description

Specifies which version of a message template to use as the active version of the template.

Members

Version

: Type: string

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 Versions resource.

TemplateConfiguration

Description

Specifies the message template to use for the message, for each type of channel.

Members

EmailTemplate

: Type: Template structure

The email template to use for the message.

InAppTemplate

: Type: Template structure

The InApp template to use for the message. The InApp template object is not supported for SendMessages.

PushTemplate

: Type: Template structure

The push notification template to use for the message.

SMSTemplate

: Type: Template structure

The SMS template to use for the message.

VoiceTemplate

: Type: Template structure

The voice template to use for the message. This object isn't supported for campaigns.

TemplateCreateMessageBody

Description

Provides information about a request to create a message template.

Members

Arn

: Type: string

The Amazon Resource Name (ARN) of the message template that was created.

Message

: Type: string

The message that's returned from the API for the request to create the message template.

RequestID

: Type: string

The unique identifier for the request to create the message template.

TemplateResponse

Description

Provides information about a message template that's associated with your Amazon Pinpoint account.

Members

Arn

: Type: 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

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the message template was created.

DefaultSubstitutions

: Type: 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

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the message template was last modified.

TemplateDescription

: Type: 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

: Required: Yes
: Type: string

The name of the message template.

TemplateType

: Required: Yes
: Type: string

The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.

Version

: Type: string

The unique identifier, as an integer, for the active version of the message template.

tags

: Type: Associative array of custom strings keys (__string) to strings

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.

TemplateVersionResponse

Description

Provides information about a specific version of a message template.

Members

CreationDate

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the version of the message template was created.

DefaultSubstitutions

: Type: 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

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the version of the message template was last modified.

TemplateDescription

: Type: string

The custom description of the version of the message template.

TemplateName

: Required: Yes
: Type: string

The name of the message template.

TemplateType

: Required: Yes
: Type: string

The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.

Version

: Type: 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.

TemplateVersionsResponse

Description

Provides information about all the versions of a specific message template.

Members

Item

: Required: Yes
: Type: Array of TemplateVersionResponse structures

An array of responses, one for each version of the message template.

Message

: Type: string

The message that's returned from the API for the request to retrieve information about all the versions of the message template.

NextToken

: Type: 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

: Type: string

The unique identifier for the request to retrieve information about all the versions of the message template.

TemplatesResponse

Description

Provides information about all the message templates that are associated with your Amazon Pinpoint account.

Members

Item

: Required: Yes
: Type: Array of TemplateResponse structures

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.

NextToken

: Type: 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.

TooManyRequestsException

Description

Provides information about an API request or response.

Members

Message

: Type: string

RequestID

: Type: string

TreatmentResource

Description

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.

Members

CustomDeliveryConfiguration

: Type: CustomDeliveryConfiguration structure

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.

Id

: Required: Yes
: Type: string

The unique identifier for the treatment.

MessageConfiguration

: Type: MessageConfiguration structure

The message configuration settings for the treatment.

Schedule

: Type: Schedule structure

The schedule settings for the treatment.

SizePercent

: Required: Yes
: Type: int

The allocated percentage of users (segment members) that the treatment is sent to.

State

: Type: CampaignState structure

The current status of the treatment.

TemplateConfiguration

: Type: TemplateConfiguration structure

The message template to use for the treatment.

TreatmentDescription

: Type: string

The custom description of the treatment.

TreatmentName

: Type: string

The custom name of the treatment.

UpdateAttributesRequest

Description

Specifies one or more attributes to remove from all the endpoints that are associated with an application.

Members

Blacklist

: Type: Array of strings

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.

UpdateRecommenderConfiguration

Description

Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

Members

Attributes

: Type: Associative array of custom strings keys (__string) to strings

An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

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.

Description

: Type: string

Name

: Type: string

RecommendationProviderIdType

: Type: string

PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

RecommendationProviderRoleArn

: Required: Yes
: Type: 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

: Required: Yes
: Type: string

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.

RecommendationTransformerUri

: Type: string

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.

RecommendationsDisplayName

: Type: string

RecommendationsPerMessage

: Type: int

VerificationResponse

Description

Verify OTP Message Response.

Members

Valid

: Type: boolean

Specifies whether the OTP is valid or not.

VerifyOTPMessageRequestParameters

Description

Verify OTP message request.

Members

DestinationIdentity

: Required: Yes
: Type: string

The destination identity to send OTP to.

Otp

: Required: Yes
: Type: string

The OTP the end user provided for verification.

ReferenceId

: Required: Yes
: Type: string

The reference identifier provided when the OTP was previously sent.

VoiceChannelRequest

Description

Specifies the status and settings of the voice channel for an application.

Members

Enabled

: Type: boolean

Specifies whether to enable the voice channel for the application.

VoiceChannelResponse

Description

Provides information about the status and settings of the voice channel for an application.

Members

ApplicationId

: Type: string

The unique identifier for the application that the voice channel applies to.

CreationDate

: Type: string

The date and time, in ISO 8601 format, when the voice channel was enabled.

Enabled

: Type: boolean

Specifies whether the voice channel is enabled for the application.

HasCredential

: Type: boolean

(Not used) This property is retained only for backward compatibility.

Id

: Type: string

(Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.

IsArchived

: Type: boolean

Specifies whether the voice channel is archived.

LastModifiedBy

: Type: string

The user who last modified the voice channel.

LastModifiedDate

: Type: string

The date and time, in ISO 8601 format, when the voice channel was last modified.

Platform

: Required: Yes
: Type: string

The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.

Version

: Type: int

The current version of the voice channel.

VoiceMessage

Description

Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.

Members

Body

: Type: string

The text of the script to use for the voice message.

LanguageCode

: Type: string

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.

OriginationNumber

: Type: string

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.

Substitutions

: Type: Associative array of custom strings keys (__string) to stringss

The default message variables to use in the voice message. You can override the default variables with individual address variables.

VoiceId

: Type: string

The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.

VoiceTemplateRequest

Description

Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

Members

Body

: Type: string

The text of the script to use in messages that are based on the message template, in plain text format.

DefaultSubstitutions

: Type: string

LanguageCode

: Type: string

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.

TemplateDescription

: Type: string

A custom description of the message template.

VoiceId

: Type: string

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.

tags

: Type: Associative array of custom strings keys (__string) to strings

(Deprecated) 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.

VoiceTemplateResponse

Description

Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.

Members

Arn

: Type: string

The Amazon Resource Name (ARN) of the message template.

Body

: Type: string

The text of the script that's used in messages that are based on the message template, in plain text format.

CreationDate

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the message template was created.

DefaultSubstitutions

: Type: string

LanguageCode

: Type: 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

: Required: Yes
: Type: string

The date, in ISO 8601 format, when the message template was last modified.

TemplateDescription

: Type: string

The custom description of the message template.

TemplateName

: Required: Yes
: Type: string

The name of the message template.

TemplateType

: Required: Yes
: Type: string

The type of channel that the message template is designed for. For a voice template, this value is VOICE.

Version

: Type: 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

: Type: 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.

tags

: Type: Associative array of custom strings keys (__string) to strings

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.

WaitActivity

Description

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.

Members

NextActivity

: Type: string

The unique identifier for the next activity to perform, after performing the wait activity.

WaitTime

: Type: WaitTime structure

The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.

WaitTime

Description

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.

Members

WaitFor

: Type: 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

: Type: 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.

WriteApplicationSettingsRequest

Description

Specifies the default settings for an application.

Members

CampaignHook

: Type: CampaignHook structure

To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.

CloudWatchMetricsEnabled

: Type: boolean

Specifies whether to enable application-related alarms in Amazon CloudWatch.

JourneyLimits

: Type: ApplicationSettingsJourneyLimits structure

The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.

Limits

: Type: CampaignLimits structure

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 Campaign resource or the Journey resource, respectively.

QuietTime

: Type: QuietTime structure

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:

The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

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 Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.

WriteCampaignRequest

Description

Specifies the configuration and other settings for a campaign.

Members

AdditionalTreatments

: Type: Array of WriteTreatmentResource structures

An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

CustomDeliveryConfiguration

: Type: CustomDeliveryConfiguration structure

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.

Description

: Type: string

A custom description of the campaign.

HoldoutPercent

: Type: int

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

Hook

: Type: CampaignHook structure

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.

IsPaused

: Type: boolean

Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

Limits

: Type: CampaignLimits structure

The messaging limits for the campaign.

MessageConfiguration

: Type: MessageConfiguration structure

The message configuration settings for the campaign.

Name

: Type: string

A custom name for the campaign.

Priority

: Type: int

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.

Schedule

: Type: Schedule structure

The schedule settings for the campaign.

SegmentId

: Type: string

The unique identifier for the segment to associate with the campaign.

SegmentVersion

: Type: int

The version of the segment to associate with the campaign.

TemplateConfiguration

: Type: TemplateConfiguration structure

The message template to use for the campaign.

TreatmentDescription

: Type: string

A custom description of the default treatment for the campaign.

TreatmentName

: Type: string

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.

tags

: Type: Associative array of custom strings keys (__string) to strings

(Deprecated) 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.

WriteEventStream

Description

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.

Members

DestinationStreamArn

: Required: Yes
: Type: string

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

RoleArn

: Required: Yes
: Type: string

The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

WriteJourneyRequest

Description

Specifies the configuration and other settings for a journey.

Members

Activities

: Type: Associative array of custom strings keys (__string) to Activity structures

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.

ClosedDays

: Type: ClosedDays structure

The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.

CreationDate

: Type: string

The date, in ISO 8601 format, when the journey was created.

JourneyChannelSettings

: Type: JourneyChannelSettings structure

IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.

LastModifiedDate

: Type: string

The date, in ISO 8601 format, when the journey was last modified.

Limits

: Type: JourneyLimits structure

The messaging and entry limits for the journey.

LocalTime

: Type: boolean

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.

Name

: Required: Yes
: Type: string

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.

OpenHours

: Type: OpenHours structure

The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.

QuietTime

: Type: QuietTime structure

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:

The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

RefreshFrequency

: Type: string

The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

RefreshOnSegmentUpdate

: Type: boolean

Indicates whether the journey participants should be refreshed when a segment is updated.

Schedule

: Type: JourneySchedule structure

The schedule settings for the journey.

SendingSchedule

: Type: boolean

Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.

StartActivity

: Type: string

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.

StartCondition

: Type: StartCondition structure

The segment that defines which users are participants in the journey.

State

: Type: string

The status of the journey. Valid values are:

DRAFT - Saves the journey and doesn't publish it.
ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

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 State resource.

TimezoneEstimationMethods

: Type: Array of strings

An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.

PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.
POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.

POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.

WaitForQuietTime

: Type: boolean

Indicates whether endpoints in quiet hours should enter a wait activity until quiet hours have elapsed.

WriteSegmentRequest

Description

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.

Members

Dimensions

: Type: SegmentDimensions structure

The criteria that define the dimensions for the segment.

Name

: Type: string

The name of the segment.

SegmentGroups

: Type: SegmentGroupList structure

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.

tags

: Type: Associative array of custom strings keys (__string) to strings

(Deprecated) 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.

WriteTreatmentResource

Description

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.

Members

CustomDeliveryConfiguration

: Type: CustomDeliveryConfiguration structure

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.

MessageConfiguration

: Type: MessageConfiguration structure

The message configuration settings for the treatment.

Schedule

: Type: Schedule structure

The schedule settings for the treatment.

SizePercent

: Required: Yes
: Type: int

The allocated percentage of users (segment members) to send the treatment to.

TemplateConfiguration

: Type: TemplateConfiguration structure

The message template to use for the treatment.

TreatmentDescription

: Type: string

A custom description of the treatment.

TreatmentName

: Type: string

A custom name for the treatment.

Amazon Pinpoint 2016-12-01

Operation Summary

Operations

CreateApp

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateCampaign

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateEmailTemplate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateExportJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateImportJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateInAppTemplate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateJourney

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreatePushTemplate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateRecommenderConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateSegment

Parameter Syntax

Parameter Details

Members

Result Syntax