AWS API Changes

2018/03/08 - Amazon Pinpoint - 4 new 13 updated api methods

Changes With this release, you can export endpoints from your Amazon Pinpoint projects. You can export a) all of the endpoints assigned to a project or b) the subset of endpoints assigned to a segment.

GetSegmentExportJobs (new)

Link ¶

Returns a list of export jobs for a specific segment.

See also: AWS API Documentation

Request Syntax

client.get_segment_export_jobs(
    ApplicationId='string',
    PageSize='string',
    SegmentId='string',
    Token='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type PageSize

string

param PageSize

The number of entries you want on each page in the response.

type SegmentId

string

param SegmentId

[REQUIRED]

type Token

string

param Token

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

rtype

dict

returns

Response Syntax

{
    'ExportJobsResponse': {
        'Item': [
            {
                'ApplicationId': 'string',
                'CompletedPieces': 123,
                'CompletionDate': 'string',
                'CreationDate': 'string',
                'Definition': {
                    'RoleArn': 'string',
                    'S3UrlPrefix': 'string',
                    'SegmentId': 'string'
                },
                'FailedPieces': 123,
                'Failures': [
                    'string',
                ],
                'Id': 'string',
                'JobStatus': 'CREATED'|'INITIALIZING'|'PROCESSING'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
                'TotalFailures': 123,
                'TotalPieces': 123,
                'TotalProcessed': 123,
                'Type': 'string'
            },
        ],
        'NextToken': 'string'
    }
}

Response Structure

(dict) --
- ExportJobsResponse (dict) -- Export job list.
  - Item (list) -- A list of export jobs for the application.
    - (dict) --
      - ApplicationId (string) -- The unique ID of the application to which the job applies.
      - CompletedPieces (integer) -- The number of pieces that have successfully completed as of the time of the request.
      - CompletionDate (string) -- The date the job completed in ISO 8601 format.
      - CreationDate (string) -- The date the job was created in ISO 8601 format.
      - Definition (dict) -- The export job settings.
        
        RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
        
        S3UrlPrefix (string) -- A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
        
        SegmentId (string) -- The ID of the segment to export endpoints from. If not present, all endpoints are exported.
      - FailedPieces (integer) -- The number of pieces that failed to be processed as of the time of the request.
      - Failures (list) -- Provides up to 100 of the first failed entries for the job, if any exist.
        
        (string) --
      - Id (string) -- The unique ID of the job.
      - JobStatus (string) -- The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.
      - TotalFailures (integer) -- The number of endpoints that were not processed; for example, because of syntax errors.
      - TotalPieces (integer) -- The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.
      - TotalProcessed (integer) -- The number of endpoints that were processed by the job.
      - Type (string) -- The job type. Will be 'EXPORT'.
  - NextToken (string) -- The string that you use in a subsequent request to get the next page of results in a paginated response.

CreateExportJob (new)

Link ¶

Creates an export job.

See also: AWS API Documentation

Request Syntax

client.create_export_job(
    ApplicationId='string',
    ExportJobRequest={
        'RoleArn': 'string',
        'S3UrlPrefix': 'string',
        'SegmentId': 'string'
    }
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type ExportJobRequest

dict

param ExportJobRequest

[REQUIRED]

RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
S3UrlPrefix (string) -- A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
SegmentId (string) -- The ID of the segment to export endpoints from. If not present all endpoints will be exported.

rtype

dict

returns

Response Syntax

{
    'ExportJobResponse': {
        'ApplicationId': 'string',
        'CompletedPieces': 123,
        'CompletionDate': 'string',
        'CreationDate': 'string',
        'Definition': {
            'RoleArn': 'string',
            'S3UrlPrefix': 'string',
            'SegmentId': 'string'
        },
        'FailedPieces': 123,
        'Failures': [
            'string',
        ],
        'Id': 'string',
        'JobStatus': 'CREATED'|'INITIALIZING'|'PROCESSING'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
        'TotalFailures': 123,
        'TotalPieces': 123,
        'TotalProcessed': 123,
        'Type': 'string'
    }
}

Response Structure

(dict) --
- ExportJobResponse (dict) --
  - ApplicationId (string) -- The unique ID of the application to which the job applies.
  - CompletedPieces (integer) -- The number of pieces that have successfully completed as of the time of the request.
  - CompletionDate (string) -- The date the job completed in ISO 8601 format.
  - CreationDate (string) -- The date the job was created in ISO 8601 format.
  - Definition (dict) -- The export job settings.
    - RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
    - S3UrlPrefix (string) -- A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
    - SegmentId (string) -- The ID of the segment to export endpoints from. If not present, all endpoints are exported.
  - FailedPieces (integer) -- The number of pieces that failed to be processed as of the time of the request.
  - Failures (list) -- Provides up to 100 of the first failed entries for the job, if any exist.
    - (string) --
  - Id (string) -- The unique ID of the job.
  - JobStatus (string) -- The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.
  - TotalFailures (integer) -- The number of endpoints that were not processed; for example, because of syntax errors.
  - TotalPieces (integer) -- The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.
  - TotalProcessed (integer) -- The number of endpoints that were processed by the job.
  - Type (string) -- The job type. Will be 'EXPORT'.

GetExportJobs (new)

Link ¶

Returns information about your export jobs.

See also: AWS API Documentation

Request Syntax

client.get_export_jobs(
    ApplicationId='string',
    PageSize='string',
    Token='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type PageSize

string

param PageSize

The number of entries you want on each page in the response.

type Token

string

param Token

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

rtype

dict

returns

Response Syntax

{
    'ExportJobsResponse': {
        'Item': [
            {
                'ApplicationId': 'string',
                'CompletedPieces': 123,
                'CompletionDate': 'string',
                'CreationDate': 'string',
                'Definition': {
                    'RoleArn': 'string',
                    'S3UrlPrefix': 'string',
                    'SegmentId': 'string'
                },
                'FailedPieces': 123,
                'Failures': [
                    'string',
                ],
                'Id': 'string',
                'JobStatus': 'CREATED'|'INITIALIZING'|'PROCESSING'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
                'TotalFailures': 123,
                'TotalPieces': 123,
                'TotalProcessed': 123,
                'Type': 'string'
            },
        ],
        'NextToken': 'string'
    }
}

Response Structure

(dict) --
- ExportJobsResponse (dict) -- Export job list.
  - Item (list) -- A list of export jobs for the application.
    - (dict) --
      - ApplicationId (string) -- The unique ID of the application to which the job applies.
      - CompletedPieces (integer) -- The number of pieces that have successfully completed as of the time of the request.
      - CompletionDate (string) -- The date the job completed in ISO 8601 format.
      - CreationDate (string) -- The date the job was created in ISO 8601 format.
      - Definition (dict) -- The export job settings.
        
        RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
        
        S3UrlPrefix (string) -- A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
        
        SegmentId (string) -- The ID of the segment to export endpoints from. If not present, all endpoints are exported.
      - FailedPieces (integer) -- The number of pieces that failed to be processed as of the time of the request.
      - Failures (list) -- Provides up to 100 of the first failed entries for the job, if any exist.
        
        (string) --
      - Id (string) -- The unique ID of the job.
      - JobStatus (string) -- The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.
      - TotalFailures (integer) -- The number of endpoints that were not processed; for example, because of syntax errors.
      - TotalPieces (integer) -- The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.
      - TotalProcessed (integer) -- The number of endpoints that were processed by the job.
      - Type (string) -- The job type. Will be 'EXPORT'.
  - NextToken (string) -- The string that you use in a subsequent request to get the next page of results in a paginated response.

GetExportJob (new)

Link ¶

Returns information about an export job.

See also: AWS API Documentation

Request Syntax

client.get_export_job(
    ApplicationId='string',
    JobId='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type JobId

string

param JobId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'ExportJobResponse': {
        'ApplicationId': 'string',
        'CompletedPieces': 123,
        'CompletionDate': 'string',
        'CreationDate': 'string',
        'Definition': {
            'RoleArn': 'string',
            'S3UrlPrefix': 'string',
            'SegmentId': 'string'
        },
        'FailedPieces': 123,
        'Failures': [
            'string',
        ],
        'Id': 'string',
        'JobStatus': 'CREATED'|'INITIALIZING'|'PROCESSING'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
        'TotalFailures': 123,
        'TotalPieces': 123,
        'TotalProcessed': 123,
        'Type': 'string'
    }
}

Response Structure

(dict) --
- ExportJobResponse (dict) --
  - ApplicationId (string) -- The unique ID of the application to which the job applies.
  - CompletedPieces (integer) -- The number of pieces that have successfully completed as of the time of the request.
  - CompletionDate (string) -- The date the job completed in ISO 8601 format.
  - CreationDate (string) -- The date the job was created in ISO 8601 format.
  - Definition (dict) -- The export job settings.
    - RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
    - S3UrlPrefix (string) -- A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
    - SegmentId (string) -- The ID of the segment to export endpoints from. If not present, all endpoints are exported.
  - FailedPieces (integer) -- The number of pieces that failed to be processed as of the time of the request.
  - Failures (list) -- Provides up to 100 of the first failed entries for the job, if any exist.
    - (string) --
  - Id (string) -- The unique ID of the job.
  - JobStatus (string) -- The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.
  - TotalFailures (integer) -- The number of endpoints that were not processed; for example, because of syntax errors.
  - TotalPieces (integer) -- The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.
  - TotalProcessed (integer) -- The number of endpoints that were processed by the job.
  - Type (string) -- The job type. Will be 'EXPORT'.

CreateCampaign (updated)

Link ¶
Changes (request, response)
Request

{'WriteCampaignRequest': {'Hook': {'LambdaFunctionName': 'string',
                                   'Mode': 'DELIVERY | FILTER',
                                   'WebUrl': 'string'}}}

Response

{'CampaignResponse': {'Hook': {'LambdaFunctionName': 'string',
                               'Mode': 'DELIVERY | FILTER',
                               'WebUrl': 'string'}}}

Creates or updates a campaign.

See also: AWS API Documentation

Request Syntax

client.create_campaign(
    ApplicationId='string',
    WriteCampaignRequest={
        'AdditionalTreatments': [
            {
                '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,
                        '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,
                        '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,
                        'Title': 'string',
                        'Url': '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,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SizePercent': 123,
                'TreatmentDescription': 'string',
                'TreatmentName': 'string'
            },
        ],
        'Description': 'string',
        'HoldoutPercent': 123,
        'Hook': {
            'LambdaFunctionName': 'string',
            'Mode': 'DELIVERY'|'FILTER',
            'WebUrl': 'string'
        },
        'IsPaused': True|False,
        'Limits': {
            'Daily': 123,
            'MaximumDuration': 123,
            'MessagesPerSecond': 123,
            'Total': 123
        },
        'MessageConfiguration': {
            'ADMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                '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,
                '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,
                'Title': 'string',
                'Url': '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,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'TreatmentDescription': 'string',
        'TreatmentName': 'string'
    }
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type WriteCampaignRequest

dict

param WriteCampaignRequest

[REQUIRED] Used to create a campaign.

AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
- (dict) -- Used to create a campaign treatment.
  - MessageConfiguration (dict) -- The message configuration settings.
    - ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - DefaultMessage (dict) -- The default message for all channels.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - EmailMessage (dict) -- The email message configuration.
      - Body (string) -- The email text body.
      - FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
      - HtmlBody (string) -- The email html body.
      - Title (string) -- The email title (Or subject).
    - GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - SMSMessage (dict) -- The SMS message configuration.
      - Body (string) -- The SMS text body.
      - MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
      - SenderId (string) -- Sender ID of sent message.
  - Schedule (dict) -- The campaign schedule.
    - EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
    - Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
    - IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
    - QuietTime (dict) -- The time during which the campaign sends no messages.
      - End (string) -- The default end time for quiet time in ISO 8601 format.
      - Start (string) -- The default start time for quiet time in ISO 8601 format.
    - StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
    - Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
  - SizePercent (integer) -- The allocated percentage of users for this treatment.
  - TreatmentDescription (string) -- A custom description for the treatment.
  - TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Hook (dict) -- Campaign hook information.
- LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
- Mode (string) -- What mode Lambda should be invoked in.
- WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
Limits (dict) -- The campaign limits settings.
- Daily (integer) -- The maximum number of messages that the campaign can send daily.
- MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
- MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
- Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
- ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
  - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
  - Body (string) -- The message body. Can include up to 140 characters.
  - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
  - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
  - ImageUrl (string) -- The URL that points to an image used in the push notification.
  - JsonBody (string) -- The JSON payload used for a silent push.
  - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
  - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - Title (string) -- The message title that displays above the message on the user's device.
  - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
- APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
  - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
  - Body (string) -- The message body. Can include up to 140 characters.
  - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
  - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
  - ImageUrl (string) -- The URL that points to an image used in the push notification.
  - JsonBody (string) -- The JSON payload used for a silent push.
  - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
  - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - Title (string) -- The message title that displays above the message on the user's device.
  - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
- BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
  - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
  - Body (string) -- The message body. Can include up to 140 characters.
  - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
  - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
  - ImageUrl (string) -- The URL that points to an image used in the push notification.
  - JsonBody (string) -- The JSON payload used for a silent push.
  - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
  - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - Title (string) -- The message title that displays above the message on the user's device.
  - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
- DefaultMessage (dict) -- The default message for all channels.
  - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
  - Body (string) -- The message body. Can include up to 140 characters.
  - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
  - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
  - ImageUrl (string) -- The URL that points to an image used in the push notification.
  - JsonBody (string) -- The JSON payload used for a silent push.
  - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
  - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - Title (string) -- The message title that displays above the message on the user's device.
  - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
- EmailMessage (dict) -- The email message configuration.
  - Body (string) -- The email text body.
  - FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
  - HtmlBody (string) -- The email html body.
  - Title (string) -- The email title (Or subject).
- GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
  - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
  - Body (string) -- The message body. Can include up to 140 characters.
  - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
  - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
  - ImageUrl (string) -- The URL that points to an image used in the push notification.
  - JsonBody (string) -- The JSON payload used for a silent push.
  - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
  - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - Title (string) -- The message title that displays above the message on the user's device.
  - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
- SMSMessage (dict) -- The SMS message configuration.
  - Body (string) -- The SMS text body.
  - MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
  - SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
- EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
- Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
- IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
- QuietTime (dict) -- The time during which the campaign sends no messages.
  - End (string) -- The default end time for quiet time in ISO 8601 format.
  - Start (string) -- The default start time for quiet time in ISO 8601 format.
- StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
- Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.

rtype

dict

returns

Response Syntax

{
    'CampaignResponse': {
        'AdditionalTreatments': [
            {
                '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,
                        '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,
                        '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,
                        'Title': 'string',
                        'Url': '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,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SizePercent': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string'
            },
        ],
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'DefaultState': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
        },
        'Description': 'string',
        'HoldoutPercent': 123,
        'Hook': {
            'LambdaFunctionName': 'string',
            'Mode': 'DELIVERY'|'FILTER',
            'WebUrl': 'string'
        },
        'Id': 'string',
        'IsPaused': True|False,
        'LastModifiedDate': 'string',
        'Limits': {
            'Daily': 123,
            'MaximumDuration': 123,
            'MessagesPerSecond': 123,
            'Total': 123
        },
        '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,
                '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,
                '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,
                'Title': 'string',
                'Url': '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,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'State': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
        },
        'TreatmentDescription': 'string',
        'TreatmentName': 'string',
        'Version': 123
    }
}

Response Structure

(dict) --
- CampaignResponse (dict) -- Campaign definition
  - AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
    - (dict) -- Treatment resource
      - Id (string) -- The unique treatment ID.
      - MessageConfiguration (dict) -- The message configuration settings.
        
        ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        DefaultMessage (dict) -- The default message for all channels.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        EmailMessage (dict) -- The email message configuration.
        
        Body (string) -- The email text body.
        
        FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
        
        HtmlBody (string) -- The email html body.
        
        Title (string) -- The email title (Or subject).
        
        GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        SMSMessage (dict) -- The SMS message configuration.
        
        Body (string) -- The SMS text body.
        
        MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
        
        SenderId (string) -- Sender ID of sent message.
      - Schedule (dict) -- The campaign schedule.
        
        EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The time during which the campaign sends no messages.
        
        End (string) -- The default end time for quiet time in ISO 8601 format.
        
        Start (string) -- The default start time for quiet time in ISO 8601 format.
        
        StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
        
        Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
      - SizePercent (integer) -- The allocated percentage of users for this treatment.
      - State (dict) -- The treatment status.
        
        CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
      - TreatmentDescription (string) -- A custom description for the treatment.
      - TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
  - ApplicationId (string) -- The ID of the application to which the campaign applies.
  - CreationDate (string) -- The date the campaign was created in ISO 8601 format.
  - DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
    - CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
  - Description (string) -- A description of the campaign.
  - HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
  - Hook (dict) -- Campaign hook information.
    - LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
    - Mode (string) -- What mode Lambda should be invoked in.
    - WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
  - Id (string) -- The unique campaign ID.
  - IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
  - LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
  - Limits (dict) -- The campaign limits settings.
    - Daily (integer) -- The maximum number of messages that the campaign can send daily.
    - MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
    - MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
    - Total (integer) -- The maximum total number of messages that the campaign can send.
  - MessageConfiguration (dict) -- The message configuration settings.
    - ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - DefaultMessage (dict) -- The default message for all channels.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - EmailMessage (dict) -- The email message configuration.
      - Body (string) -- The email text body.
      - FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
      - HtmlBody (string) -- The email html body.
      - Title (string) -- The email title (Or subject).
    - GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - SMSMessage (dict) -- The SMS message configuration.
      - Body (string) -- The SMS text body.
      - MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
      - SenderId (string) -- Sender ID of sent message.
  - Name (string) -- The custom name of the campaign.
  - Schedule (dict) -- The campaign schedule.
    - EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
    - Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
    - IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
    - QuietTime (dict) -- The time during which the campaign sends no messages.
      - End (string) -- The default end time for quiet time in ISO 8601 format.
      - Start (string) -- The default start time for quiet time in ISO 8601 format.
    - StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
    - Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
  - SegmentId (string) -- The ID of the segment to which the campaign sends messages.
  - SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
  - State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
    - CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
  - TreatmentDescription (string) -- A custom description for the treatment.
  - TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
  - Version (integer) -- The campaign version number.

DeleteCampaign (updated)

Link ¶
Changes (response)

{'CampaignResponse': {'Hook': {'LambdaFunctionName': 'string',
                               'Mode': 'DELIVERY | FILTER',
                               'WebUrl': 'string'}}}

Deletes a campaign.

See also: AWS API Documentation

Request Syntax

client.delete_campaign(
    ApplicationId='string',
    CampaignId='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type CampaignId

string

param CampaignId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'CampaignResponse': {
        'AdditionalTreatments': [
            {
                '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,
                        '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,
                        '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,
                        'Title': 'string',
                        'Url': '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,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SizePercent': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string'
            },
        ],
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'DefaultState': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
        },
        'Description': 'string',
        'HoldoutPercent': 123,
        'Hook': {
            'LambdaFunctionName': 'string',
            'Mode': 'DELIVERY'|'FILTER',
            'WebUrl': 'string'
        },
        'Id': 'string',
        'IsPaused': True|False,
        'LastModifiedDate': 'string',
        'Limits': {
            'Daily': 123,
            'MaximumDuration': 123,
            'MessagesPerSecond': 123,
            'Total': 123
        },
        '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,
                '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,
                '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,
                'Title': 'string',
                'Url': '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,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'State': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
        },
        'TreatmentDescription': 'string',
        'TreatmentName': 'string',
        'Version': 123
    }
}

Response Structure

(dict) --
- CampaignResponse (dict) -- Campaign definition
  - AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
    - (dict) -- Treatment resource
      - Id (string) -- The unique treatment ID.
      - MessageConfiguration (dict) -- The message configuration settings.
        
        ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        DefaultMessage (dict) -- The default message for all channels.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        EmailMessage (dict) -- The email message configuration.
        
        Body (string) -- The email text body.
        
        FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
        
        HtmlBody (string) -- The email html body.
        
        Title (string) -- The email title (Or subject).
        
        GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        SMSMessage (dict) -- The SMS message configuration.
        
        Body (string) -- The SMS text body.
        
        MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
        
        SenderId (string) -- Sender ID of sent message.
      - Schedule (dict) -- The campaign schedule.
        
        EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The time during which the campaign sends no messages.
        
        End (string) -- The default end time for quiet time in ISO 8601 format.
        
        Start (string) -- The default start time for quiet time in ISO 8601 format.
        
        StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
        
        Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
      - SizePercent (integer) -- The allocated percentage of users for this treatment.
      - State (dict) -- The treatment status.
        
        CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
      - TreatmentDescription (string) -- A custom description for the treatment.
      - TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
  - ApplicationId (string) -- The ID of the application to which the campaign applies.
  - CreationDate (string) -- The date the campaign was created in ISO 8601 format.
  - DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
    - CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
  - Description (string) -- A description of the campaign.
  - HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
  - Hook (dict) -- Campaign hook information.
    - LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
    - Mode (string) -- What mode Lambda should be invoked in.
    - WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
  - Id (string) -- The unique campaign ID.
  - IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
  - LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
  - Limits (dict) -- The campaign limits settings.
    - Daily (integer) -- The maximum number of messages that the campaign can send daily.
    - MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
    - MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
    - Total (integer) -- The maximum total number of messages that the campaign can send.
  - MessageConfiguration (dict) -- The message configuration settings.
    - ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - DefaultMessage (dict) -- The default message for all channels.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - EmailMessage (dict) -- The email message configuration.
      - Body (string) -- The email text body.
      - FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
      - HtmlBody (string) -- The email html body.
      - Title (string) -- The email title (Or subject).
    - GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - SMSMessage (dict) -- The SMS message configuration.
      - Body (string) -- The SMS text body.
      - MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
      - SenderId (string) -- Sender ID of sent message.
  - Name (string) -- The custom name of the campaign.
  - Schedule (dict) -- The campaign schedule.
    - EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
    - Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
    - IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
    - QuietTime (dict) -- The time during which the campaign sends no messages.
      - End (string) -- The default end time for quiet time in ISO 8601 format.
      - Start (string) -- The default start time for quiet time in ISO 8601 format.
    - StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
    - Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
  - SegmentId (string) -- The ID of the segment to which the campaign sends messages.
  - SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
  - State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
    - CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
  - TreatmentDescription (string) -- A custom description for the treatment.
  - TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
  - Version (integer) -- The campaign version number.

GetApplicationSettings (updated)

Link ¶
Changes (response)

{'ApplicationSettingsResource': {'CampaignHook': {'LambdaFunctionName': 'string',
                                                  'Mode': 'DELIVERY | FILTER',
                                                  'WebUrl': 'string'}}}

Used to request the settings for an app.

See also: AWS API Documentation

Request Syntax

client.get_application_settings(
    ApplicationId='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'ApplicationSettingsResource': {
        'ApplicationId': 'string',
        'CampaignHook': {
            'LambdaFunctionName': 'string',
            'Mode': 'DELIVERY'|'FILTER',
            'WebUrl': 'string'
        },
        'LastModifiedDate': 'string',
        'Limits': {
            'Daily': 123,
            'MaximumDuration': 123,
            'MessagesPerSecond': 123,
            'Total': 123
        },
        'QuietTime': {
            'End': 'string',
            'Start': 'string'
        }
    }
}

Response Structure

(dict) --
- ApplicationSettingsResource (dict) -- Application settings.
  - ApplicationId (string) -- The unique ID for the application.
  - CampaignHook (dict) -- Default campaign hook.
    - LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
    - Mode (string) -- What mode Lambda should be invoked in.
    - WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
  - LastModifiedDate (string) -- The date that the settings were last updated in ISO 8601 format.
  - Limits (dict) -- The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.
    - Daily (integer) -- The maximum number of messages that the campaign can send daily.
    - MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
    - MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
    - Total (integer) -- The maximum total number of messages that the campaign can send.
  - QuietTime (dict) -- The default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own.
    - End (string) -- The default end time for quiet time in ISO 8601 format.
    - Start (string) -- The default start time for quiet time in ISO 8601 format.

GetCampaign (updated)

Link ¶
Changes (response)

{'CampaignResponse': {'Hook': {'LambdaFunctionName': 'string',
                               'Mode': 'DELIVERY | FILTER',
                               'WebUrl': 'string'}}}

Returns information about a campaign.

See also: AWS API Documentation

Request Syntax

client.get_campaign(
    ApplicationId='string',
    CampaignId='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type CampaignId

string

param CampaignId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'CampaignResponse': {
        'AdditionalTreatments': [
            {
                '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,
                        '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,
                        '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,
                        'Title': 'string',
                        'Url': '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,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SizePercent': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string'
            },
        ],
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'DefaultState': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
        },
        'Description': 'string',
        'HoldoutPercent': 123,
        'Hook': {
            'LambdaFunctionName': 'string',
            'Mode': 'DELIVERY'|'FILTER',
            'WebUrl': 'string'
        },
        'Id': 'string',
        'IsPaused': True|False,
        'LastModifiedDate': 'string',
        'Limits': {
            'Daily': 123,
            'MaximumDuration': 123,
            'MessagesPerSecond': 123,
            'Total': 123
        },
        '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,
                '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,
                '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,
                'Title': 'string',
                'Url': '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,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'State': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
        },
        'TreatmentDescription': 'string',
        'TreatmentName': 'string',
        'Version': 123
    }
}

Response Structure

(dict) --
- CampaignResponse (dict) -- Campaign definition
  - AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
    - (dict) -- Treatment resource
      - Id (string) -- The unique treatment ID.
      - MessageConfiguration (dict) -- The message configuration settings.
        
        ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        DefaultMessage (dict) -- The default message for all channels.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        EmailMessage (dict) -- The email message configuration.
        
        Body (string) -- The email text body.
        
        FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
        
        HtmlBody (string) -- The email html body.
        
        Title (string) -- The email title (Or subject).
        
        GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        SMSMessage (dict) -- The SMS message configuration.
        
        Body (string) -- The SMS text body.
        
        MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
        
        SenderId (string) -- Sender ID of sent message.
      - Schedule (dict) -- The campaign schedule.
        
        EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The time during which the campaign sends no messages.
        
        End (string) -- The default end time for quiet time in ISO 8601 format.
        
        Start (string) -- The default start time for quiet time in ISO 8601 format.
        
        StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
        
        Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
      - SizePercent (integer) -- The allocated percentage of users for this treatment.
      - State (dict) -- The treatment status.
        
        CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
      - TreatmentDescription (string) -- A custom description for the treatment.
      - TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
  - ApplicationId (string) -- The ID of the application to which the campaign applies.
  - CreationDate (string) -- The date the campaign was created in ISO 8601 format.
  - DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
    - CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
  - Description (string) -- A description of the campaign.
  - HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
  - Hook (dict) -- Campaign hook information.
    - LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
    - Mode (string) -- What mode Lambda should be invoked in.
    - WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
  - Id (string) -- The unique campaign ID.
  - IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
  - LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
  - Limits (dict) -- The campaign limits settings.
    - Daily (integer) -- The maximum number of messages that the campaign can send daily.
    - MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
    - MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
    - Total (integer) -- The maximum total number of messages that the campaign can send.
  - MessageConfiguration (dict) -- The message configuration settings.
    - ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - DefaultMessage (dict) -- The default message for all channels.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - EmailMessage (dict) -- The email message configuration.
      - Body (string) -- The email text body.
      - FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
      - HtmlBody (string) -- The email html body.
      - Title (string) -- The email title (Or subject).
    - GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - SMSMessage (dict) -- The SMS message configuration.
      - Body (string) -- The SMS text body.
      - MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
      - SenderId (string) -- Sender ID of sent message.
  - Name (string) -- The custom name of the campaign.
  - Schedule (dict) -- The campaign schedule.
    - EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
    - Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
    - IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
    - QuietTime (dict) -- The time during which the campaign sends no messages.
      - End (string) -- The default end time for quiet time in ISO 8601 format.
      - Start (string) -- The default start time for quiet time in ISO 8601 format.
    - StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
    - Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
  - SegmentId (string) -- The ID of the segment to which the campaign sends messages.
  - SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
  - State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
    - CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
  - TreatmentDescription (string) -- A custom description for the treatment.
  - TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
  - Version (integer) -- The campaign version number.

GetCampaignVersion (updated)

Link ¶
Changes (response)

{'CampaignResponse': {'Hook': {'LambdaFunctionName': 'string',
                               'Mode': 'DELIVERY | FILTER',
                               'WebUrl': 'string'}}}

Returns information about a specific version of a campaign.

See also: AWS API Documentation

Request Syntax

client.get_campaign_version(
    ApplicationId='string',
    CampaignId='string',
    Version='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type CampaignId

string

param CampaignId

[REQUIRED]

type Version

string

param Version

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'CampaignResponse': {
        'AdditionalTreatments': [
            {
                '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,
                        '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,
                        '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,
                        'Title': 'string',
                        'Url': '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,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SizePercent': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string'
            },
        ],
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'DefaultState': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
        },
        'Description': 'string',
        'HoldoutPercent': 123,
        'Hook': {
            'LambdaFunctionName': 'string',
            'Mode': 'DELIVERY'|'FILTER',
            'WebUrl': 'string'
        },
        'Id': 'string',
        'IsPaused': True|False,
        'LastModifiedDate': 'string',
        'Limits': {
            'Daily': 123,
            'MaximumDuration': 123,
            'MessagesPerSecond': 123,
            'Total': 123
        },
        '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,
                '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,
                '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,
                'Title': 'string',
                'Url': '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,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'State': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
        },
        'TreatmentDescription': 'string',
        'TreatmentName': 'string',
        'Version': 123
    }
}

Response Structure

(dict) --
- CampaignResponse (dict) -- Campaign definition
  - AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
    - (dict) -- Treatment resource
      - Id (string) -- The unique treatment ID.
      - MessageConfiguration (dict) -- The message configuration settings.
        
        ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        DefaultMessage (dict) -- The default message for all channels.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        EmailMessage (dict) -- The email message configuration.
        
        Body (string) -- The email text body.
        
        FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
        
        HtmlBody (string) -- The email html body.
        
        Title (string) -- The email title (Or subject).
        
        GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        SMSMessage (dict) -- The SMS message configuration.
        
        Body (string) -- The SMS text body.
        
        MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
        
        SenderId (string) -- Sender ID of sent message.
      - Schedule (dict) -- The campaign schedule.
        
        EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The time during which the campaign sends no messages.
        
        End (string) -- The default end time for quiet time in ISO 8601 format.
        
        Start (string) -- The default start time for quiet time in ISO 8601 format.
        
        StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
        
        Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
      - SizePercent (integer) -- The allocated percentage of users for this treatment.
      - State (dict) -- The treatment status.
        
        CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
      - TreatmentDescription (string) -- A custom description for the treatment.
      - TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
  - ApplicationId (string) -- The ID of the application to which the campaign applies.
  - CreationDate (string) -- The date the campaign was created in ISO 8601 format.
  - DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
    - CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
  - Description (string) -- A description of the campaign.
  - HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
  - Hook (dict) -- Campaign hook information.
    - LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
    - Mode (string) -- What mode Lambda should be invoked in.
    - WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
  - Id (string) -- The unique campaign ID.
  - IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
  - LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
  - Limits (dict) -- The campaign limits settings.
    - Daily (integer) -- The maximum number of messages that the campaign can send daily.
    - MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
    - MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
    - Total (integer) -- The maximum total number of messages that the campaign can send.
  - MessageConfiguration (dict) -- The message configuration settings.
    - ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - DefaultMessage (dict) -- The default message for all channels.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - EmailMessage (dict) -- The email message configuration.
      - Body (string) -- The email text body.
      - FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
      - HtmlBody (string) -- The email html body.
      - Title (string) -- The email title (Or subject).
    - GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - SMSMessage (dict) -- The SMS message configuration.
      - Body (string) -- The SMS text body.
      - MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
      - SenderId (string) -- Sender ID of sent message.
  - Name (string) -- The custom name of the campaign.
  - Schedule (dict) -- The campaign schedule.
    - EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
    - Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
    - IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
    - QuietTime (dict) -- The time during which the campaign sends no messages.
      - End (string) -- The default end time for quiet time in ISO 8601 format.
      - Start (string) -- The default start time for quiet time in ISO 8601 format.
    - StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
    - Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
  - SegmentId (string) -- The ID of the segment to which the campaign sends messages.
  - SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
  - State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
    - CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
  - TreatmentDescription (string) -- A custom description for the treatment.
  - TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
  - Version (integer) -- The campaign version number.

GetCampaignVersions (updated)

Link ¶
Changes (response)

{'CampaignsResponse': {'Item': {'Hook': {'LambdaFunctionName': 'string',
                                         'Mode': 'DELIVERY | FILTER',
                                         'WebUrl': 'string'}}}}

Returns information about your campaign versions.

See also: AWS API Documentation

Request Syntax

client.get_campaign_versions(
    ApplicationId='string',
    CampaignId='string',
    PageSize='string',
    Token='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type CampaignId

string

param CampaignId

[REQUIRED]

type PageSize

string

param PageSize

The number of entries you want on each page in the response.

type Token

string

param Token

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

rtype

dict

returns

Response Syntax

{
    'CampaignsResponse': {
        'Item': [
            {
                'AdditionalTreatments': [
                    {
                        '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,
                                '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,
                                '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,
                                'Title': 'string',
                                'Url': '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,
                                'Title': 'string',
                                'Url': 'string'
                            },
                            'EmailMessage': {
                                'Body': 'string',
                                'FromAddress': 'string',
                                'HtmlBody': 'string',
                                'Title': 'string'
                            },
                            'GCMMessage': {
                                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                                'Body': 'string',
                                'ImageIconUrl': 'string',
                                'ImageSmallIconUrl': 'string',
                                'ImageUrl': 'string',
                                'JsonBody': 'string',
                                'MediaUrl': 'string',
                                'RawContent': 'string',
                                'SilentPush': True|False,
                                'Title': 'string',
                                'Url': 'string'
                            },
                            'SMSMessage': {
                                'Body': 'string',
                                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                                'SenderId': 'string'
                            }
                        },
                        'Schedule': {
                            'EndTime': 'string',
                            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
                            'IsLocalTime': True|False,
                            'QuietTime': {
                                'End': 'string',
                                'Start': 'string'
                            },
                            'StartTime': 'string',
                            'Timezone': 'string'
                        },
                        'SizePercent': 123,
                        'State': {
                            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
                        },
                        'TreatmentDescription': 'string',
                        'TreatmentName': 'string'
                    },
                ],
                'ApplicationId': 'string',
                'CreationDate': 'string',
                'DefaultState': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
                },
                'Description': 'string',
                'HoldoutPercent': 123,
                'Hook': {
                    'LambdaFunctionName': 'string',
                    'Mode': 'DELIVERY'|'FILTER',
                    'WebUrl': 'string'
                },
                'Id': 'string',
                'IsPaused': True|False,
                'LastModifiedDate': 'string',
                'Limits': {
                    'Daily': 123,
                    'MaximumDuration': 123,
                    'MessagesPerSecond': 123,
                    'Total': 123
                },
                '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,
                        '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,
                        '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,
                        'Title': 'string',
                        'Url': '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,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Name': 'string',
                'Schedule': {
                    'EndTime': 'string',
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SegmentId': 'string',
                'SegmentVersion': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string',
                'Version': 123
            },
        ],
        'NextToken': 'string'
    }
}

Response Structure

(dict) --
- CampaignsResponse (dict) -- List of available campaigns.
  - Item (list) -- A list of campaigns.
    - (dict) -- Campaign definition
      - AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
        
        (dict) -- Treatment resource
        
        Id (string) -- The unique treatment ID.
        
        MessageConfiguration (dict) -- The message configuration settings.
        
        ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        DefaultMessage (dict) -- The default message for all channels.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        EmailMessage (dict) -- The email message configuration.
        
        Body (string) -- The email text body.
        
        FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
        
        HtmlBody (string) -- The email html body.
        
        Title (string) -- The email title (Or subject).
        
        GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        SMSMessage (dict) -- The SMS message configuration.
        
        Body (string) -- The SMS text body.
        
        MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
        
        SenderId (string) -- Sender ID of sent message.
        
        Schedule (dict) -- The campaign schedule.
        
        EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The time during which the campaign sends no messages.
        
        End (string) -- The default end time for quiet time in ISO 8601 format.
        
        Start (string) -- The default start time for quiet time in ISO 8601 format.
        
        StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
        
        Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
        
        SizePercent (integer) -- The allocated percentage of users for this treatment.
        
        State (dict) -- The treatment status.
        
        CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
        
        TreatmentDescription (string) -- A custom description for the treatment.
        
        TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
      - ApplicationId (string) -- The ID of the application to which the campaign applies.
      - CreationDate (string) -- The date the campaign was created in ISO 8601 format.
      - DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
        
        CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
      - Description (string) -- A description of the campaign.
      - HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
      - Hook (dict) -- Campaign hook information.
        
        LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
        
        Mode (string) -- What mode Lambda should be invoked in.
        
        WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
      - Id (string) -- The unique campaign ID.
      - IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
      - LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
      - Limits (dict) -- The campaign limits settings.
        
        Daily (integer) -- The maximum number of messages that the campaign can send daily.
        
        MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
        
        MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
        
        Total (integer) -- The maximum total number of messages that the campaign can send.
      - MessageConfiguration (dict) -- The message configuration settings.
        
        ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        DefaultMessage (dict) -- The default message for all channels.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        EmailMessage (dict) -- The email message configuration.
        
        Body (string) -- The email text body.
        
        FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
        
        HtmlBody (string) -- The email html body.
        
        Title (string) -- The email title (Or subject).
        
        GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        SMSMessage (dict) -- The SMS message configuration.
        
        Body (string) -- The SMS text body.
        
        MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
        
        SenderId (string) -- Sender ID of sent message.
      - Name (string) -- The custom name of the campaign.
      - Schedule (dict) -- The campaign schedule.
        
        EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The time during which the campaign sends no messages.
        
        End (string) -- The default end time for quiet time in ISO 8601 format.
        
        Start (string) -- The default start time for quiet time in ISO 8601 format.
        
        StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
        
        Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
      - SegmentId (string) -- The ID of the segment to which the campaign sends messages.
      - SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
      - State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
        
        CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
      - TreatmentDescription (string) -- A custom description for the treatment.
      - TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
      - Version (integer) -- The campaign version number.
  - NextToken (string) -- The string that you use in a subsequent request to get the next page of results in a paginated response.

GetCampaigns (updated)

Link ¶
Changes (response)

{'CampaignsResponse': {'Item': {'Hook': {'LambdaFunctionName': 'string',
                                         'Mode': 'DELIVERY | FILTER',
                                         'WebUrl': 'string'}}}}

Returns information about your campaigns.

See also: AWS API Documentation

Request Syntax

client.get_campaigns(
    ApplicationId='string',
    PageSize='string',
    Token='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type PageSize

string

param PageSize

The number of entries you want on each page in the response.

type Token

string

param Token

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

rtype

dict

returns

Response Syntax

{
    'CampaignsResponse': {
        'Item': [
            {
                'AdditionalTreatments': [
                    {
                        '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,
                                '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,
                                '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,
                                'Title': 'string',
                                'Url': '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,
                                'Title': 'string',
                                'Url': 'string'
                            },
                            'EmailMessage': {
                                'Body': 'string',
                                'FromAddress': 'string',
                                'HtmlBody': 'string',
                                'Title': 'string'
                            },
                            'GCMMessage': {
                                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                                'Body': 'string',
                                'ImageIconUrl': 'string',
                                'ImageSmallIconUrl': 'string',
                                'ImageUrl': 'string',
                                'JsonBody': 'string',
                                'MediaUrl': 'string',
                                'RawContent': 'string',
                                'SilentPush': True|False,
                                'Title': 'string',
                                'Url': 'string'
                            },
                            'SMSMessage': {
                                'Body': 'string',
                                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                                'SenderId': 'string'
                            }
                        },
                        'Schedule': {
                            'EndTime': 'string',
                            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
                            'IsLocalTime': True|False,
                            'QuietTime': {
                                'End': 'string',
                                'Start': 'string'
                            },
                            'StartTime': 'string',
                            'Timezone': 'string'
                        },
                        'SizePercent': 123,
                        'State': {
                            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
                        },
                        'TreatmentDescription': 'string',
                        'TreatmentName': 'string'
                    },
                ],
                'ApplicationId': 'string',
                'CreationDate': 'string',
                'DefaultState': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
                },
                'Description': 'string',
                'HoldoutPercent': 123,
                'Hook': {
                    'LambdaFunctionName': 'string',
                    'Mode': 'DELIVERY'|'FILTER',
                    'WebUrl': 'string'
                },
                'Id': 'string',
                'IsPaused': True|False,
                'LastModifiedDate': 'string',
                'Limits': {
                    'Daily': 123,
                    'MaximumDuration': 123,
                    'MessagesPerSecond': 123,
                    'Total': 123
                },
                '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,
                        '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,
                        '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,
                        'Title': 'string',
                        'Url': '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,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Name': 'string',
                'Schedule': {
                    'EndTime': 'string',
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SegmentId': 'string',
                'SegmentVersion': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string',
                'Version': 123
            },
        ],
        'NextToken': 'string'
    }
}

Response Structure

(dict) --
- CampaignsResponse (dict) -- List of available campaigns.
  - Item (list) -- A list of campaigns.
    - (dict) -- Campaign definition
      - AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
        
        (dict) -- Treatment resource
        
        Id (string) -- The unique treatment ID.
        
        MessageConfiguration (dict) -- The message configuration settings.
        
        ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        DefaultMessage (dict) -- The default message for all channels.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        EmailMessage (dict) -- The email message configuration.
        
        Body (string) -- The email text body.
        
        FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
        
        HtmlBody (string) -- The email html body.
        
        Title (string) -- The email title (Or subject).
        
        GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        SMSMessage (dict) -- The SMS message configuration.
        
        Body (string) -- The SMS text body.
        
        MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
        
        SenderId (string) -- Sender ID of sent message.
        
        Schedule (dict) -- The campaign schedule.
        
        EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The time during which the campaign sends no messages.
        
        End (string) -- The default end time for quiet time in ISO 8601 format.
        
        Start (string) -- The default start time for quiet time in ISO 8601 format.
        
        StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
        
        Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
        
        SizePercent (integer) -- The allocated percentage of users for this treatment.
        
        State (dict) -- The treatment status.
        
        CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
        
        TreatmentDescription (string) -- A custom description for the treatment.
        
        TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
      - ApplicationId (string) -- The ID of the application to which the campaign applies.
      - CreationDate (string) -- The date the campaign was created in ISO 8601 format.
      - DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
        
        CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
      - Description (string) -- A description of the campaign.
      - HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
      - Hook (dict) -- Campaign hook information.
        
        LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
        
        Mode (string) -- What mode Lambda should be invoked in.
        
        WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
      - Id (string) -- The unique campaign ID.
      - IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
      - LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
      - Limits (dict) -- The campaign limits settings.
        
        Daily (integer) -- The maximum number of messages that the campaign can send daily.
        
        MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
        
        MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
        
        Total (integer) -- The maximum total number of messages that the campaign can send.
      - MessageConfiguration (dict) -- The message configuration settings.
        
        ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        DefaultMessage (dict) -- The default message for all channels.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        EmailMessage (dict) -- The email message configuration.
        
        Body (string) -- The email text body.
        
        FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
        
        HtmlBody (string) -- The email html body.
        
        Title (string) -- The email title (Or subject).
        
        GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        SMSMessage (dict) -- The SMS message configuration.
        
        Body (string) -- The SMS text body.
        
        MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
        
        SenderId (string) -- Sender ID of sent message.
      - Name (string) -- The custom name of the campaign.
      - Schedule (dict) -- The campaign schedule.
        
        EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The time during which the campaign sends no messages.
        
        End (string) -- The default end time for quiet time in ISO 8601 format.
        
        Start (string) -- The default start time for quiet time in ISO 8601 format.
        
        StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
        
        Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
      - SegmentId (string) -- The ID of the segment to which the campaign sends messages.
      - SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
      - State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
        
        CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
      - TreatmentDescription (string) -- A custom description for the treatment.
      - TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
      - Version (integer) -- The campaign version number.
  - NextToken (string) -- The string that you use in a subsequent request to get the next page of results in a paginated response.

GetEndpoint (updated)

Link ¶
Changes (response)

{'EndpointResponse': {'ChannelType': ['CUSTOM']}}

Returns information about an endpoint.

See also: AWS API Documentation

Request Syntax

client.get_endpoint(
    ApplicationId='string',
    EndpointId='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type EndpointId

string

param EndpointId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'EndpointResponse': {
        'Address': 'string',
        'ApplicationId': 'string',
        'Attributes': {
            'string': [
                'string',
            ]
        },
        'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'EMAIL'|'BAIDU'|'CUSTOM',
        'CohortId': 'string',
        'CreationDate': 'string',
        'Demographic': {
            'AppVersion': 'string',
            'Locale': 'string',
            'Make': 'string',
            'Model': 'string',
            'ModelVersion': 'string',
            'Platform': 'string',
            'PlatformVersion': 'string',
            'Timezone': 'string'
        },
        'EffectiveDate': 'string',
        'EndpointStatus': 'string',
        'Id': 'string',
        'Location': {
            'City': 'string',
            'Country': 'string',
            'Latitude': 123.0,
            'Longitude': 123.0,
            'PostalCode': 'string',
            'Region': 'string'
        },
        'Metrics': {
            'string': 123.0
        },
        'OptOut': 'string',
        'RequestId': 'string',
        'User': {
            'UserAttributes': {
                'string': [
                    'string',
                ]
            },
            'UserId': 'string'
        }
    }
}

Response Structure

(dict) --
- EndpointResponse (dict) -- Endpoint response
  - Address (string) -- The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
  - ApplicationId (string) -- The ID of the application associated with the endpoint.
  - Attributes (dict) -- Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
    - (string) --
      - (list) --
        
        (string) --
  - ChannelType (string) -- The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
  - CohortId (string) -- A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
  - CreationDate (string) -- The last time the endpoint was created. Provided in ISO 8601 format.
  - Demographic (dict) -- The endpoint demographic attributes.
    - AppVersion (string) -- The version of the application associated with the endpoint.
    - Locale (string) -- The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
    - Make (string) -- The endpoint make, such as such as Apple or Samsung.
    - Model (string) -- The endpoint model, such as iPhone.
    - ModelVersion (string) -- The endpoint model version.
    - Platform (string) -- The endpoint platform, such as ios or android.
    - PlatformVersion (string) -- The endpoint platform version.
    - Timezone (string) -- The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
  - EffectiveDate (string) -- The last time the endpoint was updated. Provided in ISO 8601 format.
  - EndpointStatus (string) -- The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
  - Id (string) -- The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.
  - Location (dict) -- The endpoint location attributes.
    - City (string) -- The city where the endpoint is located.
    - Country (string) -- Country according to ISO 3166-1 Alpha-2 codes. For example, US.
    - Latitude (float) -- The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
    - Longitude (float) -- The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
    - PostalCode (string) -- The postal code or zip code of the endpoint.
    - Region (string) -- The region of the endpoint location. For example, corresponds to a state in US.
  - Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint.
    - (string) --
      - (float) --
  - OptOut (string) -- Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
  - RequestId (string) -- The unique ID for the most recent request to update the endpoint.
  - User (dict) -- Custom user-specific attributes that your app reports to Amazon Pinpoint.
    - UserAttributes (dict) -- Custom attributes that describe an end user by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
      - (string) --
        
        (list) --
        
        (string) --
    - UserId (string) -- The unique ID of the user.

SendMessages (updated)

Link ¶
Changes (request)

{'MessageRequest': {'Addresses': {'ChannelType': ['CUSTOM']}}}

Send a batch of messages

See also: AWS API Documentation

Request Syntax

client.send_messages(
    ApplicationId='string',
    MessageRequest={
        'Addresses': {
            'string': {
                'BodyOverride': 'string',
                'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'EMAIL'|'BAIDU'|'CUSTOM',
                'Context': {
                    'string': 'string'
                },
                'RawContent': 'string',
                'Substitutions': {
                    'string': [
                        'string',
                    ]
                },
                'TitleOverride': 'string'
            }
        },
        'Context': {
            'string': 'string'
        },
        'Endpoints': {
            'string': {
                'BodyOverride': 'string',
                'Context': {
                    'string': 'string'
                },
                'RawContent': 'string',
                'Substitutions': {
                    'string': [
                        'string',
                    ]
                },
                'TitleOverride': 'string'
            }
        },
        'MessageConfiguration': {
            'ADMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ConsolidationKey': 'string',
                'Data': {
                    'string': 'string'
                },
                'ExpiresAfter': 'string',
                'IconReference': 'string',
                'ImageIconUrl': 'string',
                'ImageUrl': 'string',
                'MD5': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'SmallImageIconUrl': 'string',
                'Sound': 'string',
                'Substitutions': {
                    'string': [
                        'string',
                    ]
                },
                'Title': 'string',
                'Url': 'string'
            },
            'APNSMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Badge': 123,
                'Body': 'string',
                'Category': 'string',
                'CollapseId': 'string',
                'Data': {
                    'string': 'string'
                },
                'MediaUrl': 'string',
                'PreferredAuthenticationMethod': 'string',
                'Priority': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'Sound': 'string',
                'Substitutions': {
                    'string': [
                        'string',
                    ]
                },
                'ThreadId': 'string',
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'BaiduMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'Data': {
                    'string': 'string'
                },
                'IconReference': 'string',
                'ImageIconUrl': 'string',
                'ImageUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'SmallImageIconUrl': 'string',
                'Sound': 'string',
                'Substitutions': {
                    'string': [
                        'string',
                    ]
                },
                'Title': 'string',
                'Url': 'string'
            },
            'DefaultMessage': {
                'Body': 'string',
                'Substitutions': {
                    'string': [
                        'string',
                    ]
                }
            },
            'DefaultPushNotificationMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'Data': {
                    'string': 'string'
                },
                'SilentPush': True|False,
                'Substitutions': {
                    'string': [
                        'string',
                    ]
                },
                'Title': 'string',
                'Url': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'CollapseKey': 'string',
                'Data': {
                    'string': 'string'
                },
                'IconReference': 'string',
                'ImageIconUrl': 'string',
                'ImageUrl': 'string',
                'Priority': 'string',
                'RawContent': 'string',
                'RestrictedPackageName': 'string',
                'SilentPush': True|False,
                'SmallImageIconUrl': 'string',
                'Sound': 'string',
                'Substitutions': {
                    'string': [
                        'string',
                    ]
                },
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string',
                'Substitutions': {
                    'string': [
                        'string',
                    ]
                }
            }
        }
    }
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type MessageRequest

dict

param MessageRequest

[REQUIRED] Send message request.

Addresses (dict) -- A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
- (string) --
  - (dict) -- Address configuration.
    - BodyOverride (string) -- Body override. If specified will override default body.
    - ChannelType (string) -- The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    - Context (dict) -- A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
      - (string) --
        
        (string) --
    - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
    - Substitutions (dict) -- A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.
      - (string) --
        
        (list) --
        
        (string) --
    - TitleOverride (string) -- Title override. If specified will override default title if applicable.
Context (dict) -- A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
- (string) --
  - (string) --
Endpoints (dict) -- A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
- (string) --
  - (dict) -- Endpoint send configuration.
    - BodyOverride (string) -- Body override. If specified will override default body.
    - Context (dict) -- A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
      - (string) --
        
        (string) --
    - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
    - Substitutions (dict) -- A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.
      - (string) --
        
        (list) --
        
        (string) --
    - TitleOverride (string) -- Title override. If specified will override default title if applicable.
MessageConfiguration (dict) -- Message configuration.
- ADMMessage (dict) -- The message to ADM channels. Overrides the default push notification message.
  - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
  - Body (string) -- The message body of the notification, the email body or the text message.
  - ConsolidationKey (string) -- Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one.
  - Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    - (string) --
      - (string) --
  - ExpiresAfter (string) -- Optional. Number of seconds ADM should retain the message if the device is offline
  - IconReference (string) -- The icon image name of the asset saved in your application.
  - ImageIconUrl (string) -- The URL that points to an image used as the large icon to the notification content view.
  - ImageUrl (string) -- The URL that points to an image used in the push notification.
  - MD5 (string) -- Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity
  - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - SmallImageIconUrl (string) -- The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
  - Sound (string) -- Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
  - Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
    - (string) --
      - (list) --
        
        (string) --
  - Title (string) -- The message title that displays above the message on the user's device.
  - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
- APNSMessage (dict) -- The message to APNS channels. Overrides the default push notification message.
  - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
  - Badge (integer) -- Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
  - Body (string) -- The message body of the notification, the email body or the text message.
  - Category (string) -- Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.
  - CollapseId (string) -- An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.
  - Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    - (string) --
      - (string) --
  - MediaUrl (string) -- The URL that points to a video used in the push notification.
  - PreferredAuthenticationMethod (string) -- The preferred authentication method, either "CERTIFICATE" or "TOKEN"
  - Priority (string) -- The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.
  - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - Sound (string) -- Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.
  - Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
    - (string) --
      - (list) --
        
        (string) --
  - ThreadId (string) -- Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
  - TimeToLive (integer) -- The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.
  - Title (string) -- The message title that displays above the message on the user's device.
  - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
- BaiduMessage (dict) -- The message to Baidu GCM channels. Overrides the default push notification message.
  - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
  - Body (string) -- The message body of the notification, the email body or the text message.
  - Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    - (string) --
      - (string) --
  - IconReference (string) -- The icon image name of the asset saved in your application.
  - ImageIconUrl (string) -- The URL that points to an image used as the large icon to the notification content view.
  - ImageUrl (string) -- The URL that points to an image used in the push notification.
  - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - SmallImageIconUrl (string) -- The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
  - Sound (string) -- Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
  - Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
    - (string) --
      - (list) --
        
        (string) --
  - Title (string) -- The message title that displays above the message on the user's device.
  - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
- DefaultMessage (dict) -- The default message for all channels.
  - Body (string) -- The message body of the notification, the email body or the text message.
  - Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
    - (string) --
      - (list) --
        
        (string) --
- DefaultPushNotificationMessage (dict) -- The default push notification message for all push channels.
  - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
  - Body (string) -- The message body of the notification, the email body or the text message.
  - Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    - (string) --
      - (string) --
  - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
    - (string) --
      - (list) --
        
        (string) --
  - Title (string) -- The message title that displays above the message on the user's device.
  - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
- GCMMessage (dict) -- The message to GCM channels. Overrides the default push notification message.
  - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
  - Body (string) -- The message body of the notification, the email body or the text message.
  - CollapseKey (string) -- This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.
  - Data (dict) -- The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    - (string) --
      - (string) --
  - IconReference (string) -- The icon image name of the asset saved in your application.
  - ImageIconUrl (string) -- The URL that points to an image used as the large icon to the notification content view.
  - ImageUrl (string) -- The URL that points to an image used in the push notification.
  - Priority (string) -- The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: "Normal" - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. "High" - Messages are sent immediately and might wake a sleeping device. The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. For more information, see About FCM Messages in the Firebase documentation.
  - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - RestrictedPackageName (string) -- This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
  - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - SmallImageIconUrl (string) -- The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
  - Sound (string) -- Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
  - Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
    - (string) --
      - (list) --
        
        (string) --
  - TimeToLive (integer) -- The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.
  - Title (string) -- The message title that displays above the message on the user's device.
  - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
- SMSMessage (dict) -- The message to SMS channels. Overrides the default message.
  - Body (string) -- The message body of the notification, the email body or the text message.
  - MessageType (string) -- Is this a transaction priority message or lower priority.
  - SenderId (string) -- Sender ID of sent message.
  - Substitutions (dict) -- Default message substitutions. Can be overridden by individual address substitutions.
    - (string) --
      - (list) --
        
        (string) --

rtype

dict

returns

Response Syntax

{
    'MessageResponse': {
        'ApplicationId': 'string',
        'EndpointResult': {
            'string': {
                'Address': 'string',
                'DeliveryStatus': 'SUCCESSFUL'|'THROTTLED'|'TEMPORARY_FAILURE'|'PERMANENT_FAILURE'|'UNKNOWN_FAILURE'|'OPT_OUT'|'DUPLICATE',
                'StatusCode': 123,
                'StatusMessage': 'string',
                'UpdatedToken': 'string'
            }
        },
        'RequestId': 'string',
        'Result': {
            'string': {
                'DeliveryStatus': 'SUCCESSFUL'|'THROTTLED'|'TEMPORARY_FAILURE'|'PERMANENT_FAILURE'|'UNKNOWN_FAILURE'|'OPT_OUT'|'DUPLICATE',
                'StatusCode': 123,
                'StatusMessage': 'string',
                'UpdatedToken': 'string'
            }
        }
    }
}

Response Structure

(dict) --
- MessageResponse (dict) -- Send message response.
  - ApplicationId (string) -- Application id of the message.
  - EndpointResult (dict) -- A map containing a multi part response for each address, with the endpointId as the key and the result as the value.
    - (string) --
      - (dict) -- The result from sending a message to an endpoint.
        
        Address (string) -- Address that endpoint message was delivered to.
        
        DeliveryStatus (string) -- Delivery status of message.
        
        StatusCode (integer) -- Downstream service status code.
        
        StatusMessage (string) -- Status message for message delivery.
        
        UpdatedToken (string) -- If token was updated as part of delivery. (This is GCM Specific)
  - RequestId (string) -- Original request Id for which this message was delivered.
  - Result (dict) -- A map containing a multi part response for each address, with the address as the key(Email address, phone number or push token) and the result as the value.
    - (string) --
      - (dict) -- The result from sending a message to an address.
        
        DeliveryStatus (string) -- Delivery status of message.
        
        StatusCode (integer) -- Downstream service status code.
        
        StatusMessage (string) -- Status message for message delivery.
        
        UpdatedToken (string) -- If token was updated as part of delivery. (This is GCM Specific)

UpdateApplicationSettings (updated)

Link ¶
Changes (request, response)
Request

{'WriteApplicationSettingsRequest': {'CampaignHook': {'LambdaFunctionName': 'string',
                                                      'Mode': 'DELIVERY | '
                                                              'FILTER',
                                                      'WebUrl': 'string'}}}

Response

{'ApplicationSettingsResource': {'CampaignHook': {'LambdaFunctionName': 'string',
                                                  'Mode': 'DELIVERY | FILTER',
                                                  'WebUrl': 'string'}}}

Used to update the settings for an app.

See also: AWS API Documentation

Request Syntax

client.update_application_settings(
    ApplicationId='string',
    WriteApplicationSettingsRequest={
        'CampaignHook': {
            'LambdaFunctionName': 'string',
            'Mode': 'DELIVERY'|'FILTER',
            'WebUrl': 'string'
        },
        'Limits': {
            'Daily': 123,
            'MaximumDuration': 123,
            'MessagesPerSecond': 123,
            'Total': 123
        },
        'QuietTime': {
            'End': 'string',
            'Start': 'string'
        }
    }
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type WriteApplicationSettingsRequest

dict

param WriteApplicationSettingsRequest

[REQUIRED] Creating application setting request

CampaignHook (dict) -- Default campaign hook information.
- LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
- Mode (string) -- What mode Lambda should be invoked in.
- WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
Limits (dict) -- The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.
- Daily (integer) -- The maximum number of messages that the campaign can send daily.
- MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
- MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
- Total (integer) -- The maximum total number of messages that the campaign can send.
QuietTime (dict) -- The default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own.
- End (string) -- The default end time for quiet time in ISO 8601 format.
- Start (string) -- The default start time for quiet time in ISO 8601 format.

rtype

dict

returns

Response Syntax

{
    'ApplicationSettingsResource': {
        'ApplicationId': 'string',
        'CampaignHook': {
            'LambdaFunctionName': 'string',
            'Mode': 'DELIVERY'|'FILTER',
            'WebUrl': 'string'
        },
        'LastModifiedDate': 'string',
        'Limits': {
            'Daily': 123,
            'MaximumDuration': 123,
            'MessagesPerSecond': 123,
            'Total': 123
        },
        'QuietTime': {
            'End': 'string',
            'Start': 'string'
        }
    }
}

Response Structure

(dict) --
- ApplicationSettingsResource (dict) -- Application settings.
  - ApplicationId (string) -- The unique ID for the application.
  - CampaignHook (dict) -- Default campaign hook.
    - LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
    - Mode (string) -- What mode Lambda should be invoked in.
    - WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
  - LastModifiedDate (string) -- The date that the settings were last updated in ISO 8601 format.
  - Limits (dict) -- The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.
    - Daily (integer) -- The maximum number of messages that the campaign can send daily.
    - MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
    - MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
    - Total (integer) -- The maximum total number of messages that the campaign can send.
  - QuietTime (dict) -- The default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own.
    - End (string) -- The default end time for quiet time in ISO 8601 format.
    - Start (string) -- The default start time for quiet time in ISO 8601 format.

UpdateCampaign (updated)

Link ¶
Changes (request, response)
Request

{'WriteCampaignRequest': {'Hook': {'LambdaFunctionName': 'string',
                                   'Mode': 'DELIVERY | FILTER',
                                   'WebUrl': 'string'}}}

Response

{'CampaignResponse': {'Hook': {'LambdaFunctionName': 'string',
                               'Mode': 'DELIVERY | FILTER',
                               'WebUrl': 'string'}}}

Use to update a campaign.

See also: AWS API Documentation

Request Syntax

client.update_campaign(
    ApplicationId='string',
    CampaignId='string',
    WriteCampaignRequest={
        'AdditionalTreatments': [
            {
                '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,
                        '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,
                        '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,
                        'Title': 'string',
                        'Url': '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,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SizePercent': 123,
                'TreatmentDescription': 'string',
                'TreatmentName': 'string'
            },
        ],
        'Description': 'string',
        'HoldoutPercent': 123,
        'Hook': {
            'LambdaFunctionName': 'string',
            'Mode': 'DELIVERY'|'FILTER',
            'WebUrl': 'string'
        },
        'IsPaused': True|False,
        'Limits': {
            'Daily': 123,
            'MaximumDuration': 123,
            'MessagesPerSecond': 123,
            'Total': 123
        },
        'MessageConfiguration': {
            'ADMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                '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,
                '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,
                'Title': 'string',
                'Url': '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,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'TreatmentDescription': 'string',
        'TreatmentName': 'string'
    }
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type CampaignId

string

param CampaignId

[REQUIRED]

type WriteCampaignRequest

dict

param WriteCampaignRequest

[REQUIRED] Used to create a campaign.

AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
- (dict) -- Used to create a campaign treatment.
  - MessageConfiguration (dict) -- The message configuration settings.
    - ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - DefaultMessage (dict) -- The default message for all channels.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - EmailMessage (dict) -- The email message configuration.
      - Body (string) -- The email text body.
      - FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
      - HtmlBody (string) -- The email html body.
      - Title (string) -- The email title (Or subject).
    - GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - SMSMessage (dict) -- The SMS message configuration.
      - Body (string) -- The SMS text body.
      - MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
      - SenderId (string) -- Sender ID of sent message.
  - Schedule (dict) -- The campaign schedule.
    - EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
    - Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
    - IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
    - QuietTime (dict) -- The time during which the campaign sends no messages.
      - End (string) -- The default end time for quiet time in ISO 8601 format.
      - Start (string) -- The default start time for quiet time in ISO 8601 format.
    - StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
    - Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
  - SizePercent (integer) -- The allocated percentage of users for this treatment.
  - TreatmentDescription (string) -- A custom description for the treatment.
  - TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
Description (string) -- A description of the campaign.
HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
Hook (dict) -- Campaign hook information.
- LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
- Mode (string) -- What mode Lambda should be invoked in.
- WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
Limits (dict) -- The campaign limits settings.
- Daily (integer) -- The maximum number of messages that the campaign can send daily.
- MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
- MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
- Total (integer) -- The maximum total number of messages that the campaign can send.
MessageConfiguration (dict) -- The message configuration settings.
- ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
  - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
  - Body (string) -- The message body. Can include up to 140 characters.
  - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
  - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
  - ImageUrl (string) -- The URL that points to an image used in the push notification.
  - JsonBody (string) -- The JSON payload used for a silent push.
  - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
  - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - Title (string) -- The message title that displays above the message on the user's device.
  - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
- APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
  - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
  - Body (string) -- The message body. Can include up to 140 characters.
  - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
  - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
  - ImageUrl (string) -- The URL that points to an image used in the push notification.
  - JsonBody (string) -- The JSON payload used for a silent push.
  - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
  - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - Title (string) -- The message title that displays above the message on the user's device.
  - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
- BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
  - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
  - Body (string) -- The message body. Can include up to 140 characters.
  - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
  - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
  - ImageUrl (string) -- The URL that points to an image used in the push notification.
  - JsonBody (string) -- The JSON payload used for a silent push.
  - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
  - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - Title (string) -- The message title that displays above the message on the user's device.
  - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
- DefaultMessage (dict) -- The default message for all channels.
  - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
  - Body (string) -- The message body. Can include up to 140 characters.
  - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
  - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
  - ImageUrl (string) -- The URL that points to an image used in the push notification.
  - JsonBody (string) -- The JSON payload used for a silent push.
  - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
  - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - Title (string) -- The message title that displays above the message on the user's device.
  - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
- EmailMessage (dict) -- The email message configuration.
  - Body (string) -- The email text body.
  - FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
  - HtmlBody (string) -- The email html body.
  - Title (string) -- The email title (Or subject).
- GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
  - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
  - Body (string) -- The message body. Can include up to 140 characters.
  - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
  - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
  - ImageUrl (string) -- The URL that points to an image used in the push notification.
  - JsonBody (string) -- The JSON payload used for a silent push.
  - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
  - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - Title (string) -- The message title that displays above the message on the user's device.
  - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
- SMSMessage (dict) -- The SMS message configuration.
  - Body (string) -- The SMS text body.
  - MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
  - SenderId (string) -- Sender ID of sent message.
Name (string) -- The custom name of the campaign.
Schedule (dict) -- The campaign schedule.
- EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
- Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
- IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
- QuietTime (dict) -- The time during which the campaign sends no messages.
  - End (string) -- The default end time for quiet time in ISO 8601 format.
  - Start (string) -- The default start time for quiet time in ISO 8601 format.
- StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
- Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
SegmentId (string) -- The ID of the segment to which the campaign sends messages.
SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
TreatmentDescription (string) -- A custom description for the treatment.
TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.

rtype

dict

returns

Response Syntax

{
    'CampaignResponse': {
        'AdditionalTreatments': [
            {
                '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,
                        '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,
                        '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,
                        'Title': 'string',
                        'Url': '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,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SizePercent': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string'
            },
        ],
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'DefaultState': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
        },
        'Description': 'string',
        'HoldoutPercent': 123,
        'Hook': {
            'LambdaFunctionName': 'string',
            'Mode': 'DELIVERY'|'FILTER',
            'WebUrl': 'string'
        },
        'Id': 'string',
        'IsPaused': True|False,
        'LastModifiedDate': 'string',
        'Limits': {
            'Daily': 123,
            'MaximumDuration': 123,
            'MessagesPerSecond': 123,
            'Total': 123
        },
        '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,
                '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,
                '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,
                'Title': 'string',
                'Url': '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,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'State': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'
        },
        'TreatmentDescription': 'string',
        'TreatmentName': 'string',
        'Version': 123
    }
}

Response Structure

(dict) --
- CampaignResponse (dict) -- Campaign definition
  - AdditionalTreatments (list) -- Treatments that are defined in addition to the default treatment.
    - (dict) -- Treatment resource
      - Id (string) -- The unique treatment ID.
      - MessageConfiguration (dict) -- The message configuration settings.
        
        ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        DefaultMessage (dict) -- The default message for all channels.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        EmailMessage (dict) -- The email message configuration.
        
        Body (string) -- The email text body.
        
        FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
        
        HtmlBody (string) -- The email html body.
        
        Title (string) -- The email title (Or subject).
        
        GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
        
        Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
        
        Body (string) -- The message body. Can include up to 140 characters.
        
        ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
        
        ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
        
        ImageUrl (string) -- The URL that points to an image used in the push notification.
        
        JsonBody (string) -- The JSON payload used for a silent push.
        
        MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
        
        RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
        
        SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
        
        Title (string) -- The message title that displays above the message on the user's device.
        
        Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
        
        SMSMessage (dict) -- The SMS message configuration.
        
        Body (string) -- The SMS text body.
        
        MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
        
        SenderId (string) -- Sender ID of sent message.
      - Schedule (dict) -- The campaign schedule.
        
        EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The time during which the campaign sends no messages.
        
        End (string) -- The default end time for quiet time in ISO 8601 format.
        
        Start (string) -- The default start time for quiet time in ISO 8601 format.
        
        StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
        
        Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
      - SizePercent (integer) -- The allocated percentage of users for this treatment.
      - State (dict) -- The treatment status.
        
        CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
      - TreatmentDescription (string) -- A custom description for the treatment.
      - TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
  - ApplicationId (string) -- The ID of the application to which the campaign applies.
  - CreationDate (string) -- The date the campaign was created in ISO 8601 format.
  - DefaultState (dict) -- The status of the campaign's default treatment. Only present for A/B test campaigns.
    - CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
  - Description (string) -- A description of the campaign.
  - HoldoutPercent (integer) -- The allocated percentage of end users who will not receive messages from this campaign.
  - Hook (dict) -- Campaign hook information.
    - LambdaFunctionName (string) -- Lambda function name or arn to be called for delivery
    - Mode (string) -- What mode Lambda should be invoked in.
    - WebUrl (string) -- Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
  - Id (string) -- The unique campaign ID.
  - IsPaused (boolean) -- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
  - LastModifiedDate (string) -- The date the campaign was last updated in ISO 8601 format.
  - Limits (dict) -- The campaign limits settings.
    - Daily (integer) -- The maximum number of messages that the campaign can send daily.
    - MaximumDuration (integer) -- The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
    - MessagesPerSecond (integer) -- The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
    - Total (integer) -- The maximum total number of messages that the campaign can send.
  - MessageConfiguration (dict) -- The message configuration settings.
    - ADMMessage (dict) -- The message that the campaign delivers to ADM channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - APNSMessage (dict) -- The message that the campaign delivers to APNS channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - BaiduMessage (dict) -- The message that the campaign delivers to Baidu channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - DefaultMessage (dict) -- The default message for all channels.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - EmailMessage (dict) -- The email message configuration.
      - Body (string) -- The email text body.
      - FromAddress (string) -- The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
      - HtmlBody (string) -- The email html body.
      - Title (string) -- The email title (Or subject).
    - GCMMessage (dict) -- The message that the campaign delivers to GCM channels. Overrides the default message.
      - Action (string) -- The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
      - Body (string) -- The message body. Can include up to 140 characters.
      - ImageIconUrl (string) -- The URL that points to the icon image for the push notification icon, for example, the app icon.
      - ImageSmallIconUrl (string) -- The URL that points to the small icon image for the push notification icon, for example, the app icon.
      - ImageUrl (string) -- The URL that points to an image used in the push notification.
      - JsonBody (string) -- The JSON payload used for a silent push.
      - MediaUrl (string) -- The URL that points to the media resource, for example a .mp4 or .gif file.
      - RawContent (string) -- The Raw JSON formatted string to be used as the payload. This value overrides the message.
      - SilentPush (boolean) -- Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
      - Title (string) -- The message title that displays above the message on the user's device.
      - Url (string) -- The URL to open in the user's mobile browser. Used if the value for Action is URL.
    - SMSMessage (dict) -- The SMS message configuration.
      - Body (string) -- The SMS text body.
      - MessageType (string) -- Is this is a transactional SMS message, otherwise a promotional message.
      - SenderId (string) -- Sender ID of sent message.
  - Name (string) -- The custom name of the campaign.
  - Schedule (dict) -- The campaign schedule.
    - EndTime (string) -- The scheduled time that the campaign ends in ISO 8601 format.
    - Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
    - IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
    - QuietTime (dict) -- The time during which the campaign sends no messages.
      - End (string) -- The default end time for quiet time in ISO 8601 format.
      - Start (string) -- The default start time for quiet time in ISO 8601 format.
    - StartTime (string) -- The scheduled time that the campaign begins in ISO 8601 format.
    - Timezone (string) -- The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11
  - SegmentId (string) -- The ID of the segment to which the campaign sends messages.
  - SegmentVersion (integer) -- The version of the segment to which the campaign sends messages.
  - State (dict) -- The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
    - CampaignStatus (string) -- The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
  - TreatmentDescription (string) -- A custom description for the treatment.
  - TreatmentName (string) -- The custom name of a variation of the campaign used for A/B testing.
  - Version (integer) -- The campaign version number.

UpdateEndpoint (updated)

Link ¶
Changes (request)

{'EndpointRequest': {'ChannelType': ['CUSTOM']}}

Use to update an endpoint.

See also: AWS API Documentation

Request Syntax

client.update_endpoint(
    ApplicationId='string',
    EndpointId='string',
    EndpointRequest={
        'Address': 'string',
        'Attributes': {
            'string': [
                'string',
            ]
        },
        'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'EMAIL'|'BAIDU'|'CUSTOM',
        'Demographic': {
            'AppVersion': 'string',
            'Locale': 'string',
            'Make': 'string',
            'Model': 'string',
            'ModelVersion': 'string',
            'Platform': 'string',
            'PlatformVersion': 'string',
            'Timezone': 'string'
        },
        'EffectiveDate': 'string',
        'EndpointStatus': 'string',
        'Location': {
            'City': 'string',
            'Country': 'string',
            'Latitude': 123.0,
            'Longitude': 123.0,
            'PostalCode': 'string',
            'Region': 'string'
        },
        'Metrics': {
            'string': 123.0
        },
        'OptOut': 'string',
        'RequestId': 'string',
        'User': {
            'UserAttributes': {
                'string': [
                    'string',
                ]
            },
            'UserId': 'string'
        }
    }
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type EndpointId

string

param EndpointId

[REQUIRED]

type EndpointRequest

dict

param EndpointRequest

[REQUIRED] Endpoint update request

Address (string) -- The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
Attributes (dict) -- Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
- (string) --
  - (list) --
    - (string) --
ChannelType (string) -- The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
Demographic (dict) -- The endpoint demographic attributes.
- AppVersion (string) -- The version of the application associated with the endpoint.
- Locale (string) -- The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
- Make (string) -- The endpoint make, such as such as Apple or Samsung.
- Model (string) -- The endpoint model, such as iPhone.
- ModelVersion (string) -- The endpoint model version.
- Platform (string) -- The endpoint platform, such as ios or android.
- PlatformVersion (string) -- The endpoint platform version.
- Timezone (string) -- The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
EffectiveDate (string) -- The last time the endpoint was updated. Provided in ISO 8601 format.
EndpointStatus (string) -- The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
Location (dict) -- The endpoint location attributes.
- City (string) -- The city where the endpoint is located.
- Country (string) -- Country according to ISO 3166-1 Alpha-2 codes. For example, US.
- Latitude (float) -- The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
- Longitude (float) -- The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
- PostalCode (string) -- The postal code or zip code of the endpoint.
- Region (string) -- The region of the endpoint location. For example, corresponds to a state in US.
Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint.
- (string) --
  - (float) --
OptOut (string) -- Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
RequestId (string) -- The unique ID for the most recent request to update the endpoint.
User (dict) -- Custom user-specific attributes that your app reports to Amazon Pinpoint.
- UserAttributes (dict) -- Custom attributes that describe an end user by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
  - (string) --
    - (list) --
      - (string) --
- UserId (string) -- The unique ID of the user.

rtype

dict

returns

Response Syntax

{
    'MessageBody': {
        'Message': 'string',
        'RequestID': 'string'
    }
}

Response Structure

(dict) --
- MessageBody (dict) -- Simple message object.
  - Message (string) -- The error message returned from the API.
  - RequestID (string) -- The unique message body ID.

UpdateEndpointsBatch (updated)

Link ¶
Changes (request)

{'EndpointBatchRequest': {'Item': {'ChannelType': ['CUSTOM']}}}

Use to update a batch of endpoints.

See also: AWS API Documentation

Request Syntax

client.update_endpoints_batch(
    ApplicationId='string',
    EndpointBatchRequest={
        'Item': [
            {
                'Address': 'string',
                'Attributes': {
                    'string': [
                        'string',
                    ]
                },
                'ChannelType': 'GCM'|'APNS'|'APNS_SANDBOX'|'APNS_VOIP'|'APNS_VOIP_SANDBOX'|'ADM'|'SMS'|'EMAIL'|'BAIDU'|'CUSTOM',
                'Demographic': {
                    'AppVersion': 'string',
                    'Locale': 'string',
                    'Make': 'string',
                    'Model': 'string',
                    'ModelVersion': 'string',
                    'Platform': 'string',
                    'PlatformVersion': 'string',
                    'Timezone': 'string'
                },
                'EffectiveDate': 'string',
                'EndpointStatus': 'string',
                'Id': 'string',
                'Location': {
                    'City': 'string',
                    'Country': 'string',
                    'Latitude': 123.0,
                    'Longitude': 123.0,
                    'PostalCode': 'string',
                    'Region': 'string'
                },
                'Metrics': {
                    'string': 123.0
                },
                'OptOut': 'string',
                'RequestId': 'string',
                'User': {
                    'UserAttributes': {
                        'string': [
                            'string',
                        ]
                    },
                    'UserId': 'string'
                }
            },
        ]
    }
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

type EndpointBatchRequest

dict

param EndpointBatchRequest

[REQUIRED] Endpoint batch update request.

Item (list) -- List of items to update. Maximum 100 items
- (dict) -- Endpoint update request
  - Address (string) -- The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
  - Attributes (dict) -- Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
    - (string) --
      - (list) --
        
        (string) --
  - ChannelType (string) -- The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
  - Demographic (dict) -- The endpoint demographic attributes.
    - AppVersion (string) -- The version of the application associated with the endpoint.
    - Locale (string) -- The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
    - Make (string) -- The endpoint make, such as such as Apple or Samsung.
    - Model (string) -- The endpoint model, such as iPhone.
    - ModelVersion (string) -- The endpoint model version.
    - Platform (string) -- The endpoint platform, such as ios or android.
    - PlatformVersion (string) -- The endpoint platform version.
    - Timezone (string) -- The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
  - EffectiveDate (string) -- The last time the endpoint was updated. Provided in ISO 8601 format.
  - EndpointStatus (string) -- The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
  - Id (string) -- The unique Id for the Endpoint in the batch.
  - Location (dict) -- The endpoint location attributes.
    - City (string) -- The city where the endpoint is located.
    - Country (string) -- Country according to ISO 3166-1 Alpha-2 codes. For example, US.
    - Latitude (float) -- The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
    - Longitude (float) -- The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
    - PostalCode (string) -- The postal code or zip code of the endpoint.
    - Region (string) -- The region of the endpoint location. For example, corresponds to a state in US.
  - Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint.
    - (string) --
      - (float) --
  - OptOut (string) -- Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
  - RequestId (string) -- The unique ID for the most recent request to update the endpoint.
  - User (dict) -- Custom user-specific attributes that your app reports to Amazon Pinpoint.
    - UserAttributes (dict) -- Custom attributes that describe an end user by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
      - (string) --
        
        (list) --
        
        (string) --
    - UserId (string) -- The unique ID of the user.

rtype

dict

returns

Response Syntax

{
    'MessageBody': {
        'Message': 'string',
        'RequestID': 'string'
    }
}

Response Structure

(dict) --
- MessageBody (dict) -- Simple message object.
  - Message (string) -- The error message returned from the API.
  - RequestID (string) -- The unique message body ID.