SDK for PHP 3.x

Client: Aws\Pinpoint\PinpointClient
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

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.

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

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.

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

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.

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

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.

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>',
                    ],
                    'TextPa