AWS API Changes

2019/02/26 - Amazon Pinpoint - 3 new18 updated api methods

Changes Update pinpoint client to latest version

TagResource (new)

Link ¶

Request Syntax

client.tag_resource(
    ResourceArn='string',
    TagsModel={
        'tags': {
            'string': 'string'
        }
    }
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

type TagsModel:

dict

param TagsModel:

[REQUIRED]

tags (dict) -- [REQUIRED]
- (string) --
  - (string) --

returns:

None

UntagResource (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

type TagKeys:

list

param TagKeys:

[REQUIRED] The key(s) of tag to be deleted

(string) --

returns:

None

ListTagsForResource (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceArn='string'
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

rtype:

dict

returns:

Response Syntax

{
    'TagsModel': {
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) -- 200 response
- TagsModel (dict) --
  - tags (dict) --
    - (string) --
      - (string) --

CreateApp (updated)

Link ¶
Changes (request, response)
Request

{'CreateApplicationRequest': {'tags': {'string': 'string'}}}

Response

{'ApplicationResponse': {'Arn': 'string', 'tags': {'string': 'string'}}}

Creates or updates an app.

See also: AWS API Documentation

Request Syntax

client.create_app(
    CreateApplicationRequest={
        'Name': 'string',
        'tags': {
            'string': 'string'
        }
    }
)

type CreateApplicationRequest:

dict

param CreateApplicationRequest:

[REQUIRED] Application Request.

Name (string) -- The display name of the application. Used in the Amazon Pinpoint console.
tags (dict) -- The Tags for the app.
- (string) --
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'ApplicationResponse': {
        'Arn': 'string',
        'Id': 'string',
        'Name': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) -- 201 response
- ApplicationResponse (dict) -- Application Response.
  - Arn (string) -- The arn for the application.
  - Id (string) -- The unique application ID.
  - Name (string) -- The display name of the application.
  - tags (dict) -- The Tags for the application.
    - (string) --
      - (string) --

CreateCampaign (updated)

Link ¶
Changes (request, response)
Request

{'WriteCampaignRequest': {'tags': {'string': 'string'}}}

Response

{'CampaignResponse': {'Arn': 'string', 'tags': {'string': '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,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'APNSMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'BaiduMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'DefaultMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'EventFilter': {
                        'Dimensions': {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'EventType': {
                                'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                'Values': [
                                    'string',
                                ]
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            }
                        },
                        'FilterType': 'SYSTEM'|'ENDPOINT'
                    },
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
                    '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,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'APNSMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'BaiduMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'DefaultMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'EventFilter': {
                'Dimensions': {
                    'Attributes': {
                        'string': {
                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    },
                    'EventType': {
                        'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                        'Values': [
                            'string',
                        ]
                    },
                    'Metrics': {
                        'string': {
                            'ComparisonOperator': 'string',
                            'Value': 123.0
                        }
                    }
                },
                'FilterType': 'SYSTEM'|'ENDPOINT'
            },
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'tags': {
            'string': 'string'
        },
        'TreatmentDescription': 'string',
        'TreatmentName': 'string'
    }
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED] The unique ID of your Amazon Pinpoint application.

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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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.
    - EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
      - Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
      - FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
    - Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
    - IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
    - QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
      - End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
      - Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
    - StartTime (string) -- The scheduled time 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 each campaign can send to a single endpoint in a 24-hour period.
- 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 number of messages that an individual campaign can send to a single endpoint over the course of the campaign.
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) -- A URL that refers to the location of an image or video that you want to display 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.
  - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
  - 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) -- A URL that refers to the location of an image or video that you want to display 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.
  - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
  - 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) -- A URL that refers to the location of an image or video that you want to display 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.
  - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
  - 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) -- A URL that refers to the location of an image or video that you want to display 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.
  - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
  - 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) -- A URL that refers to the location of an image or video that you want to display 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.
  - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
  - 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.
- EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
  - Dimensions (dict) -- An object that defines the dimensions for the event filter.
    - Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
      - (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
      - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
      - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
      - (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
  - FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
- Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
- IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
- QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
  - End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
  - Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
- StartTime (string) -- The scheduled time 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.
tags (dict) -- The Tags for the campaign.
- (string) --
  - (string) --
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,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'APNSMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'BaiduMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'DefaultMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'EventFilter': {
                        'Dimensions': {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'EventType': {
                                'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                'Values': [
                                    'string',
                                ]
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            }
                        },
                        'FilterType': 'SYSTEM'|'ENDPOINT'
                    },
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SizePercent': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string'
            },
        ],
        'ApplicationId': 'string',
        'Arn': 'string',
        'CreationDate': 'string',
        'DefaultState': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
        },
        '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,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'APNSMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'BaiduMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'DefaultMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'EventFilter': {
                'Dimensions': {
                    'Attributes': {
                        'string': {
                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    },
                    'EventType': {
                        'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                        'Values': [
                            'string',
                        ]
                    },
                    'Metrics': {
                        'string': {
                            'ComparisonOperator': 'string',
                            'Value': 123.0
                        }
                    }
                },
                'FilterType': 'SYSTEM'|'ENDPOINT'
            },
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'State': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
        },
        'tags': {
            'string': 'string'
        },
        'TreatmentDescription': 'string',
        'TreatmentName': 'string',
        'Version': 123
    }
}

Response Structure

(dict) -- 201 response
- 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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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.
        
        EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
        
        Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
        
        End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        StartTime (string) -- The scheduled time 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.
  - Arn (string) -- The arn for the campaign.
  - 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 each campaign can send to a single endpoint in a 24-hour period.
    - 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 number of messages that an individual campaign can send to a single endpoint over the course of the campaign.
  - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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.
    - EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
      - Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
      - FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
    - Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
    - IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
    - QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
      - End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
      - Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
    - StartTime (string) -- The scheduled time 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
  - tags (dict) -- The Tags for the campaign.
    - (string) --
      - (string) --
  - 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.

CreateSegment (updated)

Link ¶
Changes (request, response)
Request

{'WriteSegmentRequest': {'tags': {'string': 'string'}}}

Response

{'SegmentResponse': {'Arn': 'string', 'tags': {'string': 'string'}}}

Used to create or update a segment.

See also: AWS API Documentation

Request Syntax

client.create_segment(
    ApplicationId='string',
    WriteSegmentRequest={
        'Dimensions': {
            'Attributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Behavior': {
                'Recency': {
                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                    'RecencyType': 'ACTIVE'|'INACTIVE'
                }
            },
            'Demographic': {
                'AppVersion': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Channel': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'DeviceType': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Make': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Model': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Platform': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Location': {
                'Country': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'GPSPoint': {
                    'Coordinates': {
                        'Latitude': 123.0,
                        'Longitude': 123.0
                    },
                    'RangeInKilometers': 123.0
                }
            },
            'Metrics': {
                'string': {
                    'ComparisonOperator': 'string',
                    'Value': 123.0
                }
            },
            'UserAttributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            }
        },
        'Name': 'string',
        'SegmentGroups': {
            'Groups': [
                {
                    'Dimensions': [
                        {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Behavior': {
                                'Recency': {
                                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                    'RecencyType': 'ACTIVE'|'INACTIVE'
                                }
                            },
                            'Demographic': {
                                'AppVersion': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Channel': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'DeviceType': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Make': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Model': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Platform': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Location': {
                                'Country': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'GPSPoint': {
                                    'Coordinates': {
                                        'Latitude': 123.0,
                                        'Longitude': 123.0
                                    },
                                    'RangeInKilometers': 123.0
                                }
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            },
                            'UserAttributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            }
                        },
                    ],
                    'SourceSegments': [
                        {
                            'Id': 'string',
                            'Version': 123
                        },
                    ],
                    'SourceType': 'ALL'|'ANY'|'NONE',
                    'Type': 'ALL'|'ANY'|'NONE'
                },
            ],
            'Include': 'ALL'|'ANY'|'NONE'
        },
        'tags': {
            'string': 'string'
        }
    }
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED] The unique ID of your Amazon Pinpoint application.

type WriteSegmentRequest:

dict

param WriteSegmentRequest:

[REQUIRED] Segment definition.

Dimensions (dict) -- The segment dimensions attributes.
- Attributes (dict) -- Custom segment attributes.
  - (string) --
    - (dict) -- Custom attibute dimension
      - AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
      - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
- Behavior (dict) -- The segment behaviors attributes.
  - Recency (dict) -- The recency of use.
    - Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
    - RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
- Demographic (dict) -- The segment demographics attributes.
  - AppVersion (dict) -- The app version criteria for the segment.
    - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
      - (string) --
  - Channel (dict) -- The channel criteria for the segment.
    - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
      - (string) --
  - DeviceType (dict) -- The device type criteria for the segment.
    - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
      - (string) --
  - Make (dict) -- The device make criteria for the segment.
    - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
      - (string) --
  - Model (dict) -- The device model criteria for the segment.
    - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
      - (string) --
  - Platform (dict) -- The device platform criteria for the segment.
    - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
      - (string) --
- Location (dict) -- The segment location attributes.
  - Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
    - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
      - (string) --
  - GPSPoint (dict) -- The GPS Point dimension.
    - Coordinates (dict) -- Coordinate to measure distance from.
      - Latitude (float) -- Latitude
      - Longitude (float) -- Longitude
    - RangeInKilometers (float) -- Range in kilometers from the coordinate.
- Metrics (dict) -- Custom segment metrics.
  - (string) --
    - (dict) -- Custom metric dimension
      - ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
      - Value (float) -- The value to be compared.
- UserAttributes (dict) -- Custom segment user attributes.
  - (string) --
    - (dict) -- Custom attibute dimension
      - AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
      - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
Name (string) -- The name of segment
SegmentGroups (dict) -- A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments. Your request can only include one segment group. Your request can include either a SegmentGroups object or a Dimensions object, but not both.
- Groups (list) -- A set of segment criteria to evaluate.
  - (dict) -- Segment group definition.
    - Dimensions (list) -- List of dimensions to include or exclude.
      - (dict) -- Segment dimensions
        
        Attributes (dict) -- Custom segment attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Behavior (dict) -- The segment behaviors attributes.
        
        Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
        
        Demographic (dict) -- The segment demographics attributes.
        
        AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Location (dict) -- The segment location attributes.
        
        Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
        
        Metrics (dict) -- Custom segment metrics.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        UserAttributes (dict) -- Custom segment user attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - SourceSegments (list) -- The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
      - (dict) -- Segment reference.
        
        Id (string) -- A unique identifier for the segment.
        
        Version (integer) -- If specified contains a specific version of the segment included.
    - SourceType (string) -- Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.
    - Type (string) -- Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.
- Include (string) -- Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE.
tags (dict) -- The Tags for the segments.
- (string) --
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'SegmentResponse': {
        'ApplicationId': 'string',
        'Arn': 'string',
        'CreationDate': 'string',
        'Dimensions': {
            'Attributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Behavior': {
                'Recency': {
                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                    'RecencyType': 'ACTIVE'|'INACTIVE'
                }
            },
            'Demographic': {
                'AppVersion': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Channel': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'DeviceType': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Make': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Model': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Platform': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Location': {
                'Country': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'GPSPoint': {
                    'Coordinates': {
                        'Latitude': 123.0,
                        'Longitude': 123.0
                    },
                    'RangeInKilometers': 123.0
                }
            },
            'Metrics': {
                'string': {
                    'ComparisonOperator': 'string',
                    'Value': 123.0
                }
            },
            'UserAttributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            }
        },
        'Id': 'string',
        'ImportDefinition': {
            'ChannelCounts': {
                'string': 123
            },
            'ExternalId': 'string',
            'Format': 'CSV'|'JSON',
            'RoleArn': 'string',
            'S3Url': 'string',
            'Size': 123
        },
        'LastModifiedDate': 'string',
        'Name': 'string',
        'SegmentGroups': {
            'Groups': [
                {
                    'Dimensions': [
                        {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Behavior': {
                                'Recency': {
                                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                    'RecencyType': 'ACTIVE'|'INACTIVE'
                                }
                            },
                            'Demographic': {
                                'AppVersion': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Channel': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'DeviceType': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Make': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Model': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Platform': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Location': {
                                'Country': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'GPSPoint': {
                                    'Coordinates': {
                                        'Latitude': 123.0,
                                        'Longitude': 123.0
                                    },
                                    'RangeInKilometers': 123.0
                                }
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            },
                            'UserAttributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            }
                        },
                    ],
                    'SourceSegments': [
                        {
                            'Id': 'string',
                            'Version': 123
                        },
                    ],
                    'SourceType': 'ALL'|'ANY'|'NONE',
                    'Type': 'ALL'|'ANY'|'NONE'
                },
            ],
            'Include': 'ALL'|'ANY'|'NONE'
        },
        'SegmentType': 'DIMENSIONAL'|'IMPORT',
        'tags': {
            'string': 'string'
        },
        'Version': 123
    }
}

Response Structure

(dict) -- 201 response
- SegmentResponse (dict) -- Segment definition.
  - ApplicationId (string) -- The ID of the application that the segment applies to.
  - Arn (string) -- The arn for the segment.
  - CreationDate (string) -- The date and time when the segment was created.
  - Dimensions (dict) -- The segment dimensions attributes.
    - Attributes (dict) -- Custom segment attributes.
      - (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - Behavior (dict) -- The segment behaviors attributes.
      - Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
    - Demographic (dict) -- The segment demographics attributes.
      - AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - Location (dict) -- The segment location attributes.
      - Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
    - Metrics (dict) -- Custom segment metrics.
      - (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
    - UserAttributes (dict) -- Custom segment user attributes.
      - (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
  - Id (string) -- The unique segment ID.
  - ImportDefinition (dict) -- The import job settings.
    - ChannelCounts (dict) -- The number of channel types in the imported segment.
      - (string) --
        
        (integer) --
    - ExternalId (string) -- (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
    - Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
    - RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
    - S3Url (string) -- The URL of the S3 bucket that the segment was imported from.
    - Size (integer) -- The number of endpoints that were successfully imported to create this segment.
  - LastModifiedDate (string) -- The date and time when the segment was last modified.
  - Name (string) -- The name of the segment.
  - SegmentGroups (dict) -- A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
    - Groups (list) -- A set of segment criteria to evaluate.
      - (dict) -- Segment group definition.
        
        Dimensions (list) -- List of dimensions to include or exclude.
        
        (dict) -- Segment dimensions
        
        Attributes (dict) -- Custom segment attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Behavior (dict) -- The segment behaviors attributes.
        
        Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
        
        Demographic (dict) -- The segment demographics attributes.
        
        AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Location (dict) -- The segment location attributes.
        
        Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
        
        Metrics (dict) -- Custom segment metrics.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        UserAttributes (dict) -- Custom segment user attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        SourceSegments (list) -- The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
        
        (dict) -- Segment reference.
        
        Id (string) -- A unique identifier for the segment.
        
        Version (integer) -- If specified contains a specific version of the segment included.
        
        SourceType (string) -- Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.
        
        Type (string) -- Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.
    - Include (string) -- Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE.
  - SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
  - tags (dict) -- The Tags for the segment.
    - (string) --
      - (string) --
  - Version (integer) -- The segment version number.

DeleteApp (updated)

Link ¶
Changes (response)

{'ApplicationResponse': {'Arn': 'string', 'tags': {'string': 'string'}}}

Deletes an app.

See also: AWS API Documentation

Request Syntax

client.delete_app(
    ApplicationId='string'
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED] The unique ID of your Amazon Pinpoint application.

rtype:

dict

returns:

Response Syntax

{
    'ApplicationResponse': {
        'Arn': 'string',
        'Id': 'string',
        'Name': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) -- 200 response
- ApplicationResponse (dict) -- Application Response.
  - Arn (string) -- The arn for the application.
  - Id (string) -- The unique application ID.
  - Name (string) -- The display name of the application.
  - tags (dict) -- The Tags for the application.
    - (string) --
      - (string) --

DeleteCampaign (updated)

Link ¶
Changes (response)

{'CampaignResponse': {'Arn': 'string', 'tags': {'string': 'string'}}}

Deletes a campaign.

See also: AWS API Documentation

Request Syntax

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

type ApplicationId:

string

param ApplicationId:

[REQUIRED] The unique ID of your Amazon Pinpoint application.

type CampaignId:

string

param CampaignId:

[REQUIRED] The unique ID of the campaign.

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,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'APNSMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'BaiduMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'DefaultMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'EventFilter': {
                        'Dimensions': {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'EventType': {
                                'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                'Values': [
                                    'string',
                                ]
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            }
                        },
                        'FilterType': 'SYSTEM'|'ENDPOINT'
                    },
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SizePercent': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string'
            },
        ],
        'ApplicationId': 'string',
        'Arn': 'string',
        'CreationDate': 'string',
        'DefaultState': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
        },
        '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,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'APNSMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'BaiduMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'DefaultMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'EventFilter': {
                'Dimensions': {
                    'Attributes': {
                        'string': {
                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    },
                    'EventType': {
                        'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                        'Values': [
                            'string',
                        ]
                    },
                    'Metrics': {
                        'string': {
                            'ComparisonOperator': 'string',
                            'Value': 123.0
                        }
                    }
                },
                'FilterType': 'SYSTEM'|'ENDPOINT'
            },
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'State': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
        },
        'tags': {
            'string': 'string'
        },
        'TreatmentDescription': 'string',
        'TreatmentName': 'string',
        'Version': 123
    }
}

Response Structure

(dict) -- 200 response
- 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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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.
        
        EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
        
        Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
        
        End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        StartTime (string) -- The scheduled time 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.
  - Arn (string) -- The arn for the campaign.
  - 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 each campaign can send to a single endpoint in a 24-hour period.
    - 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 number of messages that an individual campaign can send to a single endpoint over the course of the campaign.
  - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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.
    - EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
      - Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
      - FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
    - Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
    - IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
    - QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
      - End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
      - Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
    - StartTime (string) -- The scheduled time 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
  - tags (dict) -- The Tags for the campaign.
    - (string) --
      - (string) --
  - 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.

DeleteSegment (updated)

Link ¶
Changes (response)

{'SegmentResponse': {'Arn': 'string', 'tags': {'string': 'string'}}}

Deletes a segment.

See also: AWS API Documentation

Request Syntax

client.delete_segment(
    ApplicationId='string',
    SegmentId='string'
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED] The unique ID of your Amazon Pinpoint application.

type SegmentId:

string

param SegmentId:

[REQUIRED] The unique ID of the segment.

rtype:

dict

returns:

Response Syntax

{
    'SegmentResponse': {
        'ApplicationId': 'string',
        'Arn': 'string',
        'CreationDate': 'string',
        'Dimensions': {
            'Attributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Behavior': {
                'Recency': {
                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                    'RecencyType': 'ACTIVE'|'INACTIVE'
                }
            },
            'Demographic': {
                'AppVersion': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Channel': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'DeviceType': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Make': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Model': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Platform': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Location': {
                'Country': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'GPSPoint': {
                    'Coordinates': {
                        'Latitude': 123.0,
                        'Longitude': 123.0
                    },
                    'RangeInKilometers': 123.0
                }
            },
            'Metrics': {
                'string': {
                    'ComparisonOperator': 'string',
                    'Value': 123.0
                }
            },
            'UserAttributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            }
        },
        'Id': 'string',
        'ImportDefinition': {
            'ChannelCounts': {
                'string': 123
            },
            'ExternalId': 'string',
            'Format': 'CSV'|'JSON',
            'RoleArn': 'string',
            'S3Url': 'string',
            'Size': 123
        },
        'LastModifiedDate': 'string',
        'Name': 'string',
        'SegmentGroups': {
            'Groups': [
                {
                    'Dimensions': [
                        {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Behavior': {
                                'Recency': {
                                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                    'RecencyType': 'ACTIVE'|'INACTIVE'
                                }
                            },
                            'Demographic': {
                                'AppVersion': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Channel': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'DeviceType': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Make': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Model': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Platform': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Location': {
                                'Country': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'GPSPoint': {
                                    'Coordinates': {
                                        'Latitude': 123.0,
                                        'Longitude': 123.0
                                    },
                                    'RangeInKilometers': 123.0
                                }
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            },
                            'UserAttributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            }
                        },
                    ],
                    'SourceSegments': [
                        {
                            'Id': 'string',
                            'Version': 123
                        },
                    ],
                    'SourceType': 'ALL'|'ANY'|'NONE',
                    'Type': 'ALL'|'ANY'|'NONE'
                },
            ],
            'Include': 'ALL'|'ANY'|'NONE'
        },
        'SegmentType': 'DIMENSIONAL'|'IMPORT',
        'tags': {
            'string': 'string'
        },
        'Version': 123
    }
}

Response Structure

(dict) -- 200 response
- SegmentResponse (dict) -- Segment definition.
  - ApplicationId (string) -- The ID of the application that the segment applies to.
  - Arn (string) -- The arn for the segment.
  - CreationDate (string) -- The date and time when the segment was created.
  - Dimensions (dict) -- The segment dimensions attributes.
    - Attributes (dict) -- Custom segment attributes.
      - (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - Behavior (dict) -- The segment behaviors attributes.
      - Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
    - Demographic (dict) -- The segment demographics attributes.
      - AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - Location (dict) -- The segment location attributes.
      - Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
    - Metrics (dict) -- Custom segment metrics.
      - (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
    - UserAttributes (dict) -- Custom segment user attributes.
      - (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
  - Id (string) -- The unique segment ID.
  - ImportDefinition (dict) -- The import job settings.
    - ChannelCounts (dict) -- The number of channel types in the imported segment.
      - (string) --
        
        (integer) --
    - ExternalId (string) -- (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
    - Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
    - RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
    - S3Url (string) -- The URL of the S3 bucket that the segment was imported from.
    - Size (integer) -- The number of endpoints that were successfully imported to create this segment.
  - LastModifiedDate (string) -- The date and time when the segment was last modified.
  - Name (string) -- The name of the segment.
  - SegmentGroups (dict) -- A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
    - Groups (list) -- A set of segment criteria to evaluate.
      - (dict) -- Segment group definition.
        
        Dimensions (list) -- List of dimensions to include or exclude.
        
        (dict) -- Segment dimensions
        
        Attributes (dict) -- Custom segment attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Behavior (dict) -- The segment behaviors attributes.
        
        Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
        
        Demographic (dict) -- The segment demographics attributes.
        
        AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Location (dict) -- The segment location attributes.
        
        Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
        
        Metrics (dict) -- Custom segment metrics.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        UserAttributes (dict) -- Custom segment user attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        SourceSegments (list) -- The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
        
        (dict) -- Segment reference.
        
        Id (string) -- A unique identifier for the segment.
        
        Version (integer) -- If specified contains a specific version of the segment included.
        
        SourceType (string) -- Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.
        
        Type (string) -- Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.
    - Include (string) -- Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE.
  - SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
  - tags (dict) -- The Tags for the segment.
    - (string) --
      - (string) --
  - Version (integer) -- The segment version number.

GetApp (updated)

Link ¶
Changes (response)

{'ApplicationResponse': {'Arn': 'string', 'tags': {'string': 'string'}}}

Returns information about an app.

See also: AWS API Documentation

Request Syntax

client.get_app(
    ApplicationId='string'
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED] The unique ID of your Amazon Pinpoint application.

rtype:

dict

returns:

Response Syntax

{
    'ApplicationResponse': {
        'Arn': 'string',
        'Id': 'string',
        'Name': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) -- 200 response
- ApplicationResponse (dict) -- Application Response.
  - Arn (string) -- The arn for the application.
  - Id (string) -- The unique application ID.
  - Name (string) -- The display name of the application.
  - tags (dict) -- The Tags for the application.
    - (string) --
      - (string) --

GetApps (updated)

Link ¶
Changes (response)

{'ApplicationsResponse': {'Item': {'Arn': 'string',
                                   'tags': {'string': 'string'}}}}

Returns information about your apps.

See also: AWS API Documentation

Request Syntax

client.get_apps(
    PageSize='string',
    Token='string'
)

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

{
    'ApplicationsResponse': {
        'Item': [
            {
                'Arn': 'string',
                'Id': 'string',
                'Name': 'string',
                'tags': {
                    'string': 'string'
                }
            },
        ],
        'NextToken': 'string'
    }
}

Response Structure

(dict) -- 200 response
- ApplicationsResponse (dict) -- Get Applications Result.
  - Item (list) -- List of applications returned in this page.
    - (dict) -- Application Response.
      - Arn (string) -- The arn for the application.
      - Id (string) -- The unique application ID.
      - Name (string) -- The display name of the application.
      - tags (dict) -- The Tags for the application.
        
        (string) --
        
        (string) --
  - NextToken (string) -- The string that you use in a subsequent request to get the next page of results in a paginated response.

GetCampaign (updated)

Link ¶
Changes (response)

{'CampaignResponse': {'Arn': 'string', 'tags': {'string': '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] The unique ID of your Amazon Pinpoint application.

type CampaignId:

string

param CampaignId:

[REQUIRED] The unique ID of the campaign.

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,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'APNSMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'BaiduMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'DefaultMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'EventFilter': {
                        'Dimensions': {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'EventType': {
                                'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                'Values': [
                                    'string',
                                ]
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            }
                        },
                        'FilterType': 'SYSTEM'|'ENDPOINT'
                    },
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SizePercent': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string'
            },
        ],
        'ApplicationId': 'string',
        'Arn': 'string',
        'CreationDate': 'string',
        'DefaultState': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
        },
        '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,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'APNSMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'BaiduMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'DefaultMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'EventFilter': {
                'Dimensions': {
                    'Attributes': {
                        'string': {
                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    },
                    'EventType': {
                        'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                        'Values': [
                            'string',
                        ]
                    },
                    'Metrics': {
                        'string': {
                            'ComparisonOperator': 'string',
                            'Value': 123.0
                        }
                    }
                },
                'FilterType': 'SYSTEM'|'ENDPOINT'
            },
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'State': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
        },
        'tags': {
            'string': 'string'
        },
        'TreatmentDescription': 'string',
        'TreatmentName': 'string',
        'Version': 123
    }
}

Response Structure

(dict) -- 200 response
- 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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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.
        
        EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
        
        Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
        
        End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        StartTime (string) -- The scheduled time 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.
  - Arn (string) -- The arn for the campaign.
  - 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 each campaign can send to a single endpoint in a 24-hour period.
    - 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 number of messages that an individual campaign can send to a single endpoint over the course of the campaign.
  - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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.
    - EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
      - Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
      - FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
    - Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
    - IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
    - QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
      - End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
      - Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
    - StartTime (string) -- The scheduled time 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
  - tags (dict) -- The Tags for the campaign.
    - (string) --
      - (string) --
  - 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': {'Arn': 'string', 'tags': {'string': '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] The unique ID of your Amazon Pinpoint application.

type CampaignId:

string

param CampaignId:

[REQUIRED] The unique ID of the campaign.

type Version:

string

param Version:

[REQUIRED] The version of the campaign.

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,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'APNSMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'BaiduMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'DefaultMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'EventFilter': {
                        'Dimensions': {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'EventType': {
                                'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                'Values': [
                                    'string',
                                ]
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            }
                        },
                        'FilterType': 'SYSTEM'|'ENDPOINT'
                    },
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SizePercent': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string'
            },
        ],
        'ApplicationId': 'string',
        'Arn': 'string',
        'CreationDate': 'string',
        'DefaultState': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
        },
        '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,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'APNSMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'BaiduMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'DefaultMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'EventFilter': {
                'Dimensions': {
                    'Attributes': {
                        'string': {
                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    },
                    'EventType': {
                        'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                        'Values': [
                            'string',
                        ]
                    },
                    'Metrics': {
                        'string': {
                            'ComparisonOperator': 'string',
                            'Value': 123.0
                        }
                    }
                },
                'FilterType': 'SYSTEM'|'ENDPOINT'
            },
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'State': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
        },
        'tags': {
            'string': 'string'
        },
        'TreatmentDescription': 'string',
        'TreatmentName': 'string',
        'Version': 123
    }
}

Response Structure

(dict) -- 200 response
- 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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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.
        
        EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
        
        Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
        
        End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        StartTime (string) -- The scheduled time 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.
  - Arn (string) -- The arn for the campaign.
  - 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 each campaign can send to a single endpoint in a 24-hour period.
    - 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 number of messages that an individual campaign can send to a single endpoint over the course of the campaign.
  - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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.
    - EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
      - Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
      - FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
    - Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
    - IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
    - QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
      - End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
      - Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
    - StartTime (string) -- The scheduled time 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
  - tags (dict) -- The Tags for the campaign.
    - (string) --
      - (string) --
  - 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': {'Arn': 'string', 'tags': {'string': '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] The unique ID of your Amazon Pinpoint application.

type CampaignId:

string

param CampaignId:

[REQUIRED] The unique ID of the campaign.

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,
                                'TimeToLive': 123,
                                'Title': 'string',
                                'Url': 'string'
                            },
                            'APNSMessage': {
                                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                                'Body': 'string',
                                'ImageIconUrl': 'string',
                                'ImageSmallIconUrl': 'string',
                                'ImageUrl': 'string',
                                'JsonBody': 'string',
                                'MediaUrl': 'string',
                                'RawContent': 'string',
                                'SilentPush': True|False,
                                'TimeToLive': 123,
                                'Title': 'string',
                                'Url': 'string'
                            },
                            'BaiduMessage': {
                                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                                'Body': 'string',
                                'ImageIconUrl': 'string',
                                'ImageSmallIconUrl': 'string',
                                'ImageUrl': 'string',
                                'JsonBody': 'string',
                                'MediaUrl': 'string',
                                'RawContent': 'string',
                                'SilentPush': True|False,
                                'TimeToLive': 123,
                                'Title': 'string',
                                'Url': 'string'
                            },
                            'DefaultMessage': {
                                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                                'Body': 'string',
                                'ImageIconUrl': 'string',
                                'ImageSmallIconUrl': 'string',
                                'ImageUrl': 'string',
                                'JsonBody': 'string',
                                'MediaUrl': 'string',
                                'RawContent': 'string',
                                'SilentPush': True|False,
                                'TimeToLive': 123,
                                'Title': 'string',
                                'Url': 'string'
                            },
                            'EmailMessage': {
                                'Body': 'string',
                                'FromAddress': 'string',
                                'HtmlBody': 'string',
                                'Title': 'string'
                            },
                            'GCMMessage': {
                                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                                'Body': 'string',
                                'ImageIconUrl': 'string',
                                'ImageSmallIconUrl': 'string',
                                'ImageUrl': 'string',
                                'JsonBody': 'string',
                                'MediaUrl': 'string',
                                'RawContent': 'string',
                                'SilentPush': True|False,
                                'TimeToLive': 123,
                                'Title': 'string',
                                'Url': 'string'
                            },
                            'SMSMessage': {
                                'Body': 'string',
                                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                                'SenderId': 'string'
                            }
                        },
                        'Schedule': {
                            'EndTime': 'string',
                            'EventFilter': {
                                'Dimensions': {
                                    'Attributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'EventType': {
                                        'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                        'Values': [
                                            'string',
                                        ]
                                    },
                                    'Metrics': {
                                        'string': {
                                            'ComparisonOperator': 'string',
                                            'Value': 123.0
                                        }
                                    }
                                },
                                'FilterType': 'SYSTEM'|'ENDPOINT'
                            },
                            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
                            'IsLocalTime': True|False,
                            'QuietTime': {
                                'End': 'string',
                                'Start': 'string'
                            },
                            'StartTime': 'string',
                            'Timezone': 'string'
                        },
                        'SizePercent': 123,
                        'State': {
                            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
                        },
                        'TreatmentDescription': 'string',
                        'TreatmentName': 'string'
                    },
                ],
                'ApplicationId': 'string',
                'Arn': 'string',
                'CreationDate': 'string',
                'DefaultState': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
                },
                '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,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'APNSMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'BaiduMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'DefaultMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Name': 'string',
                'Schedule': {
                    'EndTime': 'string',
                    'EventFilter': {
                        'Dimensions': {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'EventType': {
                                'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                'Values': [
                                    'string',
                                ]
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            }
                        },
                        'FilterType': 'SYSTEM'|'ENDPOINT'
                    },
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SegmentId': 'string',
                'SegmentVersion': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
                },
                'tags': {
                    'string': 'string'
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string',
                'Version': 123
            },
        ],
        'NextToken': 'string'
    }
}

Response Structure

(dict) -- 200 response
- 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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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.
        
        EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
        
        Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
        
        End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        StartTime (string) -- The scheduled time 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.
      - Arn (string) -- The arn for the campaign.
      - 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 each campaign can send to a single endpoint in a 24-hour period.
        
        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 number of messages that an individual campaign can send to a single endpoint over the course of the campaign.
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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.
        
        EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
        
        Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
        
        End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        StartTime (string) -- The scheduled time 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
      - tags (dict) -- The Tags for the campaign.
        
        (string) --
        
        (string) --
      - 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': {'Arn': 'string', 'tags': {'string': '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] The unique ID of your Amazon Pinpoint application.

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,
                                'TimeToLive': 123,
                                'Title': 'string',
                                'Url': 'string'
                            },
                            'APNSMessage': {
                                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                                'Body': 'string',
                                'ImageIconUrl': 'string',
                                'ImageSmallIconUrl': 'string',
                                'ImageUrl': 'string',
                                'JsonBody': 'string',
                                'MediaUrl': 'string',
                                'RawContent': 'string',
                                'SilentPush': True|False,
                                'TimeToLive': 123,
                                'Title': 'string',
                                'Url': 'string'
                            },
                            'BaiduMessage': {
                                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                                'Body': 'string',
                                'ImageIconUrl': 'string',
                                'ImageSmallIconUrl': 'string',
                                'ImageUrl': 'string',
                                'JsonBody': 'string',
                                'MediaUrl': 'string',
                                'RawContent': 'string',
                                'SilentPush': True|False,
                                'TimeToLive': 123,
                                'Title': 'string',
                                'Url': 'string'
                            },
                            'DefaultMessage': {
                                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                                'Body': 'string',
                                'ImageIconUrl': 'string',
                                'ImageSmallIconUrl': 'string',
                                'ImageUrl': 'string',
                                'JsonBody': 'string',
                                'MediaUrl': 'string',
                                'RawContent': 'string',
                                'SilentPush': True|False,
                                'TimeToLive': 123,
                                'Title': 'string',
                                'Url': 'string'
                            },
                            'EmailMessage': {
                                'Body': 'string',
                                'FromAddress': 'string',
                                'HtmlBody': 'string',
                                'Title': 'string'
                            },
                            'GCMMessage': {
                                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                                'Body': 'string',
                                'ImageIconUrl': 'string',
                                'ImageSmallIconUrl': 'string',
                                'ImageUrl': 'string',
                                'JsonBody': 'string',
                                'MediaUrl': 'string',
                                'RawContent': 'string',
                                'SilentPush': True|False,
                                'TimeToLive': 123,
                                'Title': 'string',
                                'Url': 'string'
                            },
                            'SMSMessage': {
                                'Body': 'string',
                                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                                'SenderId': 'string'
                            }
                        },
                        'Schedule': {
                            'EndTime': 'string',
                            'EventFilter': {
                                'Dimensions': {
                                    'Attributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'EventType': {
                                        'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                        'Values': [
                                            'string',
                                        ]
                                    },
                                    'Metrics': {
                                        'string': {
                                            'ComparisonOperator': 'string',
                                            'Value': 123.0
                                        }
                                    }
                                },
                                'FilterType': 'SYSTEM'|'ENDPOINT'
                            },
                            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
                            'IsLocalTime': True|False,
                            'QuietTime': {
                                'End': 'string',
                                'Start': 'string'
                            },
                            'StartTime': 'string',
                            'Timezone': 'string'
                        },
                        'SizePercent': 123,
                        'State': {
                            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
                        },
                        'TreatmentDescription': 'string',
                        'TreatmentName': 'string'
                    },
                ],
                'ApplicationId': 'string',
                'Arn': 'string',
                'CreationDate': 'string',
                'DefaultState': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
                },
                '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,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'APNSMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'BaiduMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'DefaultMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Name': 'string',
                'Schedule': {
                    'EndTime': 'string',
                    'EventFilter': {
                        'Dimensions': {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'EventType': {
                                'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                'Values': [
                                    'string',
                                ]
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            }
                        },
                        'FilterType': 'SYSTEM'|'ENDPOINT'
                    },
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SegmentId': 'string',
                'SegmentVersion': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
                },
                'tags': {
                    'string': 'string'
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string',
                'Version': 123
            },
        ],
        'NextToken': 'string'
    }
}

Response Structure

(dict) -- 200 response
- 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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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.
        
        EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
        
        Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
        
        End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        StartTime (string) -- The scheduled time 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.
      - Arn (string) -- The arn for the campaign.
      - 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 each campaign can send to a single endpoint in a 24-hour period.
        
        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 number of messages that an individual campaign can send to a single endpoint over the course of the campaign.
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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.
        
        EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
        
        Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
        
        End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        StartTime (string) -- The scheduled time 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
      - tags (dict) -- The Tags for the campaign.
        
        (string) --
        
        (string) --
      - 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.

GetSegment (updated)

Link ¶
Changes (response)

{'SegmentResponse': {'Arn': 'string', 'tags': {'string': 'string'}}}

Returns information about a segment.

See also: AWS API Documentation

Request Syntax

client.get_segment(
    ApplicationId='string',
    SegmentId='string'
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED] The unique ID of your Amazon Pinpoint application.

type SegmentId:

string

param SegmentId:

[REQUIRED] The unique ID of the segment.

rtype:

dict

returns:

Response Syntax

{
    'SegmentResponse': {
        'ApplicationId': 'string',
        'Arn': 'string',
        'CreationDate': 'string',
        'Dimensions': {
            'Attributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Behavior': {
                'Recency': {
                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                    'RecencyType': 'ACTIVE'|'INACTIVE'
                }
            },
            'Demographic': {
                'AppVersion': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Channel': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'DeviceType': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Make': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Model': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Platform': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Location': {
                'Country': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'GPSPoint': {
                    'Coordinates': {
                        'Latitude': 123.0,
                        'Longitude': 123.0
                    },
                    'RangeInKilometers': 123.0
                }
            },
            'Metrics': {
                'string': {
                    'ComparisonOperator': 'string',
                    'Value': 123.0
                }
            },
            'UserAttributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            }
        },
        'Id': 'string',
        'ImportDefinition': {
            'ChannelCounts': {
                'string': 123
            },
            'ExternalId': 'string',
            'Format': 'CSV'|'JSON',
            'RoleArn': 'string',
            'S3Url': 'string',
            'Size': 123
        },
        'LastModifiedDate': 'string',
        'Name': 'string',
        'SegmentGroups': {
            'Groups': [
                {
                    'Dimensions': [
                        {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Behavior': {
                                'Recency': {
                                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                    'RecencyType': 'ACTIVE'|'INACTIVE'
                                }
                            },
                            'Demographic': {
                                'AppVersion': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Channel': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'DeviceType': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Make': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Model': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Platform': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Location': {
                                'Country': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'GPSPoint': {
                                    'Coordinates': {
                                        'Latitude': 123.0,
                                        'Longitude': 123.0
                                    },
                                    'RangeInKilometers': 123.0
                                }
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            },
                            'UserAttributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            }
                        },
                    ],
                    'SourceSegments': [
                        {
                            'Id': 'string',
                            'Version': 123
                        },
                    ],
                    'SourceType': 'ALL'|'ANY'|'NONE',
                    'Type': 'ALL'|'ANY'|'NONE'
                },
            ],
            'Include': 'ALL'|'ANY'|'NONE'
        },
        'SegmentType': 'DIMENSIONAL'|'IMPORT',
        'tags': {
            'string': 'string'
        },
        'Version': 123
    }
}

Response Structure

(dict) -- 200 response
- SegmentResponse (dict) -- Segment definition.
  - ApplicationId (string) -- The ID of the application that the segment applies to.
  - Arn (string) -- The arn for the segment.
  - CreationDate (string) -- The date and time when the segment was created.
  - Dimensions (dict) -- The segment dimensions attributes.
    - Attributes (dict) -- Custom segment attributes.
      - (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - Behavior (dict) -- The segment behaviors attributes.
      - Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
    - Demographic (dict) -- The segment demographics attributes.
      - AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - Location (dict) -- The segment location attributes.
      - Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
    - Metrics (dict) -- Custom segment metrics.
      - (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
    - UserAttributes (dict) -- Custom segment user attributes.
      - (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
  - Id (string) -- The unique segment ID.
  - ImportDefinition (dict) -- The import job settings.
    - ChannelCounts (dict) -- The number of channel types in the imported segment.
      - (string) --
        
        (integer) --
    - ExternalId (string) -- (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
    - Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
    - RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
    - S3Url (string) -- The URL of the S3 bucket that the segment was imported from.
    - Size (integer) -- The number of endpoints that were successfully imported to create this segment.
  - LastModifiedDate (string) -- The date and time when the segment was last modified.
  - Name (string) -- The name of the segment.
  - SegmentGroups (dict) -- A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
    - Groups (list) -- A set of segment criteria to evaluate.
      - (dict) -- Segment group definition.
        
        Dimensions (list) -- List of dimensions to include or exclude.
        
        (dict) -- Segment dimensions
        
        Attributes (dict) -- Custom segment attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Behavior (dict) -- The segment behaviors attributes.
        
        Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
        
        Demographic (dict) -- The segment demographics attributes.
        
        AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Location (dict) -- The segment location attributes.
        
        Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
        
        Metrics (dict) -- Custom segment metrics.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        UserAttributes (dict) -- Custom segment user attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        SourceSegments (list) -- The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
        
        (dict) -- Segment reference.
        
        Id (string) -- A unique identifier for the segment.
        
        Version (integer) -- If specified contains a specific version of the segment included.
        
        SourceType (string) -- Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.
        
        Type (string) -- Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.
    - Include (string) -- Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE.
  - SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
  - tags (dict) -- The Tags for the segment.
    - (string) --
      - (string) --
  - Version (integer) -- The segment version number.

GetSegmentVersion (updated)

Link ¶
Changes (response)

{'SegmentResponse': {'Arn': 'string', 'tags': {'string': 'string'}}}

Returns information about a segment version.

See also: AWS API Documentation

Request Syntax

client.get_segment_version(
    ApplicationId='string',
    SegmentId='string',
    Version='string'
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED] The unique ID of your Amazon Pinpoint application.

type SegmentId:

string

param SegmentId:

[REQUIRED] The unique ID of the segment.

type Version:

string

param Version:

[REQUIRED] The segment version.

rtype:

dict

returns:

Response Syntax

{
    'SegmentResponse': {
        'ApplicationId': 'string',
        'Arn': 'string',
        'CreationDate': 'string',
        'Dimensions': {
            'Attributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Behavior': {
                'Recency': {
                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                    'RecencyType': 'ACTIVE'|'INACTIVE'
                }
            },
            'Demographic': {
                'AppVersion': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Channel': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'DeviceType': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Make': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Model': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Platform': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Location': {
                'Country': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'GPSPoint': {
                    'Coordinates': {
                        'Latitude': 123.0,
                        'Longitude': 123.0
                    },
                    'RangeInKilometers': 123.0
                }
            },
            'Metrics': {
                'string': {
                    'ComparisonOperator': 'string',
                    'Value': 123.0
                }
            },
            'UserAttributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            }
        },
        'Id': 'string',
        'ImportDefinition': {
            'ChannelCounts': {
                'string': 123
            },
            'ExternalId': 'string',
            'Format': 'CSV'|'JSON',
            'RoleArn': 'string',
            'S3Url': 'string',
            'Size': 123
        },
        'LastModifiedDate': 'string',
        'Name': 'string',
        'SegmentGroups': {
            'Groups': [
                {
                    'Dimensions': [
                        {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Behavior': {
                                'Recency': {
                                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                    'RecencyType': 'ACTIVE'|'INACTIVE'
                                }
                            },
                            'Demographic': {
                                'AppVersion': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Channel': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'DeviceType': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Make': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Model': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Platform': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Location': {
                                'Country': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'GPSPoint': {
                                    'Coordinates': {
                                        'Latitude': 123.0,
                                        'Longitude': 123.0
                                    },
                                    'RangeInKilometers': 123.0
                                }
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            },
                            'UserAttributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            }
                        },
                    ],
                    'SourceSegments': [
                        {
                            'Id': 'string',
                            'Version': 123
                        },
                    ],
                    'SourceType': 'ALL'|'ANY'|'NONE',
                    'Type': 'ALL'|'ANY'|'NONE'
                },
            ],
            'Include': 'ALL'|'ANY'|'NONE'
        },
        'SegmentType': 'DIMENSIONAL'|'IMPORT',
        'tags': {
            'string': 'string'
        },
        'Version': 123
    }
}

Response Structure

(dict) -- 200 response
- SegmentResponse (dict) -- Segment definition.
  - ApplicationId (string) -- The ID of the application that the segment applies to.
  - Arn (string) -- The arn for the segment.
  - CreationDate (string) -- The date and time when the segment was created.
  - Dimensions (dict) -- The segment dimensions attributes.
    - Attributes (dict) -- Custom segment attributes.
      - (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - Behavior (dict) -- The segment behaviors attributes.
      - Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
    - Demographic (dict) -- The segment demographics attributes.
      - AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - Location (dict) -- The segment location attributes.
      - Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
    - Metrics (dict) -- Custom segment metrics.
      - (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
    - UserAttributes (dict) -- Custom segment user attributes.
      - (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
  - Id (string) -- The unique segment ID.
  - ImportDefinition (dict) -- The import job settings.
    - ChannelCounts (dict) -- The number of channel types in the imported segment.
      - (string) --
        
        (integer) --
    - ExternalId (string) -- (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
    - Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
    - RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
    - S3Url (string) -- The URL of the S3 bucket that the segment was imported from.
    - Size (integer) -- The number of endpoints that were successfully imported to create this segment.
  - LastModifiedDate (string) -- The date and time when the segment was last modified.
  - Name (string) -- The name of the segment.
  - SegmentGroups (dict) -- A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
    - Groups (list) -- A set of segment criteria to evaluate.
      - (dict) -- Segment group definition.
        
        Dimensions (list) -- List of dimensions to include or exclude.
        
        (dict) -- Segment dimensions
        
        Attributes (dict) -- Custom segment attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Behavior (dict) -- The segment behaviors attributes.
        
        Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
        
        Demographic (dict) -- The segment demographics attributes.
        
        AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Location (dict) -- The segment location attributes.
        
        Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
        
        Metrics (dict) -- Custom segment metrics.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        UserAttributes (dict) -- Custom segment user attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        SourceSegments (list) -- The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
        
        (dict) -- Segment reference.
        
        Id (string) -- A unique identifier for the segment.
        
        Version (integer) -- If specified contains a specific version of the segment included.
        
        SourceType (string) -- Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.
        
        Type (string) -- Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.
    - Include (string) -- Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE.
  - SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
  - tags (dict) -- The Tags for the segment.
    - (string) --
      - (string) --
  - Version (integer) -- The segment version number.

GetSegmentVersions (updated)

Link ¶
Changes (response)

{'SegmentsResponse': {'Item': {'Arn': 'string', 'tags': {'string': 'string'}}}}

Returns information about your segment versions.

See also: AWS API Documentation

Request Syntax

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

type ApplicationId:

string

param ApplicationId:

[REQUIRED] The unique ID of your Amazon Pinpoint application.

type PageSize:

string

param PageSize:

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

type SegmentId:

string

param SegmentId:

[REQUIRED] The unique ID of the segment.

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

{
    'SegmentsResponse': {
        'Item': [
            {
                'ApplicationId': 'string',
                'Arn': 'string',
                'CreationDate': 'string',
                'Dimensions': {
                    'Attributes': {
                        'string': {
                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    },
                    'Behavior': {
                        'Recency': {
                            'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                            'RecencyType': 'ACTIVE'|'INACTIVE'
                        }
                    },
                    'Demographic': {
                        'AppVersion': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        },
                        'Channel': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        },
                        'DeviceType': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        },
                        'Make': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        },
                        'Model': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        },
                        'Platform': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    },
                    'Location': {
                        'Country': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        },
                        'GPSPoint': {
                            'Coordinates': {
                                'Latitude': 123.0,
                                'Longitude': 123.0
                            },
                            'RangeInKilometers': 123.0
                        }
                    },
                    'Metrics': {
                        'string': {
                            'ComparisonOperator': 'string',
                            'Value': 123.0
                        }
                    },
                    'UserAttributes': {
                        'string': {
                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    }
                },
                'Id': 'string',
                'ImportDefinition': {
                    'ChannelCounts': {
                        'string': 123
                    },
                    'ExternalId': 'string',
                    'Format': 'CSV'|'JSON',
                    'RoleArn': 'string',
                    'S3Url': 'string',
                    'Size': 123
                },
                'LastModifiedDate': 'string',
                'Name': 'string',
                'SegmentGroups': {
                    'Groups': [
                        {
                            'Dimensions': [
                                {
                                    'Attributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Behavior': {
                                        'Recency': {
                                            'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                            'RecencyType': 'ACTIVE'|'INACTIVE'
                                        }
                                    },
                                    'Demographic': {
                                        'AppVersion': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Channel': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'DeviceType': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Make': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Model': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Platform': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Location': {
                                        'Country': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'GPSPoint': {
                                            'Coordinates': {
                                                'Latitude': 123.0,
                                                'Longitude': 123.0
                                            },
                                            'RangeInKilometers': 123.0
                                        }
                                    },
                                    'Metrics': {
                                        'string': {
                                            'ComparisonOperator': 'string',
                                            'Value': 123.0
                                        }
                                    },
                                    'UserAttributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    }
                                },
                            ],
                            'SourceSegments': [
                                {
                                    'Id': 'string',
                                    'Version': 123
                                },
                            ],
                            'SourceType': 'ALL'|'ANY'|'NONE',
                            'Type': 'ALL'|'ANY'|'NONE'
                        },
                    ],
                    'Include': 'ALL'|'ANY'|'NONE'
                },
                'SegmentType': 'DIMENSIONAL'|'IMPORT',
                'tags': {
                    'string': 'string'
                },
                'Version': 123
            },
        ],
        'NextToken': 'string'
    }
}

Response Structure

(dict) -- 200 response
- SegmentsResponse (dict) -- Segments in your account.
  - Item (list) -- The list of segments.
    - (dict) -- Segment definition.
      - ApplicationId (string) -- The ID of the application that the segment applies to.
      - Arn (string) -- The arn for the segment.
      - CreationDate (string) -- The date and time when the segment was created.
      - Dimensions (dict) -- The segment dimensions attributes.
        
        Attributes (dict) -- Custom segment attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Behavior (dict) -- The segment behaviors attributes.
        
        Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
        
        Demographic (dict) -- The segment demographics attributes.
        
        AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Location (dict) -- The segment location attributes.
        
        Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
        
        Metrics (dict) -- Custom segment metrics.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        UserAttributes (dict) -- Custom segment user attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Id (string) -- The unique segment ID.
      - ImportDefinition (dict) -- The import job settings.
        
        ChannelCounts (dict) -- The number of channel types in the imported segment.
        
        (string) --
        
        (integer) --
        
        ExternalId (string) -- (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
        
        Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
        
        RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
        
        S3Url (string) -- The URL of the S3 bucket that the segment was imported from.
        
        Size (integer) -- The number of endpoints that were successfully imported to create this segment.
      - LastModifiedDate (string) -- The date and time when the segment was last modified.
      - Name (string) -- The name of the segment.
      - SegmentGroups (dict) -- A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
        
        Groups (list) -- A set of segment criteria to evaluate.
        
        (dict) -- Segment group definition.
        
        Dimensions (list) -- List of dimensions to include or exclude.
        
        (dict) -- Segment dimensions
        
        Attributes (dict) -- Custom segment attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Behavior (dict) -- The segment behaviors attributes.
        
        Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
        
        Demographic (dict) -- The segment demographics attributes.
        
        AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Location (dict) -- The segment location attributes.
        
        Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
        
        Metrics (dict) -- Custom segment metrics.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        UserAttributes (dict) -- Custom segment user attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        SourceSegments (list) -- The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
        
        (dict) -- Segment reference.
        
        Id (string) -- A unique identifier for the segment.
        
        Version (integer) -- If specified contains a specific version of the segment included.
        
        SourceType (string) -- Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.
        
        Type (string) -- Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.
        
        Include (string) -- Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE.
      - SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
      - tags (dict) -- The Tags for the segment.
        
        (string) --
        
        (string) --
      - Version (integer) -- The segment version number.
  - NextToken (string) -- An identifier used to retrieve the next page of results. The token is null if no additional pages exist.

GetSegments (updated)

Link ¶
Changes (response)

{'SegmentsResponse': {'Item': {'Arn': 'string', 'tags': {'string': 'string'}}}}

Used to get information about your segments.

See also: AWS API Documentation

Request Syntax

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

type ApplicationId:

string

param ApplicationId:

[REQUIRED] The unique ID of your Amazon Pinpoint application.

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

{
    'SegmentsResponse': {
        'Item': [
            {
                'ApplicationId': 'string',
                'Arn': 'string',
                'CreationDate': 'string',
                'Dimensions': {
                    'Attributes': {
                        'string': {
                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    },
                    'Behavior': {
                        'Recency': {
                            'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                            'RecencyType': 'ACTIVE'|'INACTIVE'
                        }
                    },
                    'Demographic': {
                        'AppVersion': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        },
                        'Channel': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        },
                        'DeviceType': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        },
                        'Make': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        },
                        'Model': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        },
                        'Platform': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    },
                    'Location': {
                        'Country': {
                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        },
                        'GPSPoint': {
                            'Coordinates': {
                                'Latitude': 123.0,
                                'Longitude': 123.0
                            },
                            'RangeInKilometers': 123.0
                        }
                    },
                    'Metrics': {
                        'string': {
                            'ComparisonOperator': 'string',
                            'Value': 123.0
                        }
                    },
                    'UserAttributes': {
                        'string': {
                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    }
                },
                'Id': 'string',
                'ImportDefinition': {
                    'ChannelCounts': {
                        'string': 123
                    },
                    'ExternalId': 'string',
                    'Format': 'CSV'|'JSON',
                    'RoleArn': 'string',
                    'S3Url': 'string',
                    'Size': 123
                },
                'LastModifiedDate': 'string',
                'Name': 'string',
                'SegmentGroups': {
                    'Groups': [
                        {
                            'Dimensions': [
                                {
                                    'Attributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Behavior': {
                                        'Recency': {
                                            'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                            'RecencyType': 'ACTIVE'|'INACTIVE'
                                        }
                                    },
                                    'Demographic': {
                                        'AppVersion': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Channel': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'DeviceType': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Make': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Model': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'Platform': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    },
                                    'Location': {
                                        'Country': {
                                            'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        },
                                        'GPSPoint': {
                                            'Coordinates': {
                                                'Latitude': 123.0,
                                                'Longitude': 123.0
                                            },
                                            'RangeInKilometers': 123.0
                                        }
                                    },
                                    'Metrics': {
                                        'string': {
                                            'ComparisonOperator': 'string',
                                            'Value': 123.0
                                        }
                                    },
                                    'UserAttributes': {
                                        'string': {
                                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                            'Values': [
                                                'string',
                                            ]
                                        }
                                    }
                                },
                            ],
                            'SourceSegments': [
                                {
                                    'Id': 'string',
                                    'Version': 123
                                },
                            ],
                            'SourceType': 'ALL'|'ANY'|'NONE',
                            'Type': 'ALL'|'ANY'|'NONE'
                        },
                    ],
                    'Include': 'ALL'|'ANY'|'NONE'
                },
                'SegmentType': 'DIMENSIONAL'|'IMPORT',
                'tags': {
                    'string': 'string'
                },
                'Version': 123
            },
        ],
        'NextToken': 'string'
    }
}

Response Structure

(dict) -- 200 response
- SegmentsResponse (dict) -- Segments in your account.
  - Item (list) -- The list of segments.
    - (dict) -- Segment definition.
      - ApplicationId (string) -- The ID of the application that the segment applies to.
      - Arn (string) -- The arn for the segment.
      - CreationDate (string) -- The date and time when the segment was created.
      - Dimensions (dict) -- The segment dimensions attributes.
        
        Attributes (dict) -- Custom segment attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Behavior (dict) -- The segment behaviors attributes.
        
        Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
        
        Demographic (dict) -- The segment demographics attributes.
        
        AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Location (dict) -- The segment location attributes.
        
        Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
        
        Metrics (dict) -- Custom segment metrics.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        UserAttributes (dict) -- Custom segment user attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Id (string) -- The unique segment ID.
      - ImportDefinition (dict) -- The import job settings.
        
        ChannelCounts (dict) -- The number of channel types in the imported segment.
        
        (string) --
        
        (integer) --
        
        ExternalId (string) -- (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
        
        Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
        
        RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
        
        S3Url (string) -- The URL of the S3 bucket that the segment was imported from.
        
        Size (integer) -- The number of endpoints that were successfully imported to create this segment.
      - LastModifiedDate (string) -- The date and time when the segment was last modified.
      - Name (string) -- The name of the segment.
      - SegmentGroups (dict) -- A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
        
        Groups (list) -- A set of segment criteria to evaluate.
        
        (dict) -- Segment group definition.
        
        Dimensions (list) -- List of dimensions to include or exclude.
        
        (dict) -- Segment dimensions
        
        Attributes (dict) -- Custom segment attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Behavior (dict) -- The segment behaviors attributes.
        
        Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
        
        Demographic (dict) -- The segment demographics attributes.
        
        AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Location (dict) -- The segment location attributes.
        
        Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
        
        Metrics (dict) -- Custom segment metrics.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        UserAttributes (dict) -- Custom segment user attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        SourceSegments (list) -- The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
        
        (dict) -- Segment reference.
        
        Id (string) -- A unique identifier for the segment.
        
        Version (integer) -- If specified contains a specific version of the segment included.
        
        SourceType (string) -- Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.
        
        Type (string) -- Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.
        
        Include (string) -- Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE.
      - SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
      - tags (dict) -- The Tags for the segment.
        
        (string) --
        
        (string) --
      - Version (integer) -- The segment version number.
  - NextToken (string) -- An identifier used to retrieve the next page of results. The token is null if no additional pages exist.

UpdateCampaign (updated)

Link ¶
Changes (request, response)
Request

{'WriteCampaignRequest': {'tags': {'string': 'string'}}}

Response

{'CampaignResponse': {'Arn': 'string', 'tags': {'string': '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,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'APNSMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'BaiduMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'DefaultMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'EventFilter': {
                        'Dimensions': {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'EventType': {
                                'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                'Values': [
                                    'string',
                                ]
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            }
                        },
                        'FilterType': 'SYSTEM'|'ENDPOINT'
                    },
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
                    '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,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'APNSMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'BaiduMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'DefaultMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'EventFilter': {
                'Dimensions': {
                    'Attributes': {
                        'string': {
                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    },
                    'EventType': {
                        'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                        'Values': [
                            'string',
                        ]
                    },
                    'Metrics': {
                        'string': {
                            'ComparisonOperator': 'string',
                            'Value': 123.0
                        }
                    }
                },
                'FilterType': 'SYSTEM'|'ENDPOINT'
            },
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'tags': {
            'string': 'string'
        },
        'TreatmentDescription': 'string',
        'TreatmentName': 'string'
    }
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED] The unique ID of your Amazon Pinpoint application.

type CampaignId:

string

param CampaignId:

[REQUIRED] The unique ID of the campaign.

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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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.
    - EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
      - Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
      - FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
    - Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
    - IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
    - QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
      - End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
      - Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
    - StartTime (string) -- The scheduled time 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 each campaign can send to a single endpoint in a 24-hour period.
- 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 number of messages that an individual campaign can send to a single endpoint over the course of the campaign.
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) -- A URL that refers to the location of an image or video that you want to display 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.
  - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
  - 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) -- A URL that refers to the location of an image or video that you want to display 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.
  - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
  - 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) -- A URL that refers to the location of an image or video that you want to display 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.
  - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
  - 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) -- A URL that refers to the location of an image or video that you want to display 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.
  - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
  - 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) -- A URL that refers to the location of an image or video that you want to display 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.
  - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
  - 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.
- EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
  - Dimensions (dict) -- An object that defines the dimensions for the event filter.
    - Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
      - (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
      - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
      - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
      - (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
  - FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
- Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
- IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
- QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
  - End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
  - Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
- StartTime (string) -- The scheduled time 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.
tags (dict) -- The Tags for the campaign.
- (string) --
  - (string) --
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,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'APNSMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'BaiduMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'DefaultMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'EmailMessage': {
                        'Body': 'string',
                        'FromAddress': 'string',
                        'HtmlBody': 'string',
                        'Title': 'string'
                    },
                    'GCMMessage': {
                        'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                        'Body': 'string',
                        'ImageIconUrl': 'string',
                        'ImageSmallIconUrl': 'string',
                        'ImageUrl': 'string',
                        'JsonBody': 'string',
                        'MediaUrl': 'string',
                        'RawContent': 'string',
                        'SilentPush': True|False,
                        'TimeToLive': 123,
                        'Title': 'string',
                        'Url': 'string'
                    },
                    'SMSMessage': {
                        'Body': 'string',
                        'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                        'SenderId': 'string'
                    }
                },
                'Schedule': {
                    'EndTime': 'string',
                    'EventFilter': {
                        'Dimensions': {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'EventType': {
                                'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                'Values': [
                                    'string',
                                ]
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            }
                        },
                        'FilterType': 'SYSTEM'|'ENDPOINT'
                    },
                    'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
                    'IsLocalTime': True|False,
                    'QuietTime': {
                        'End': 'string',
                        'Start': 'string'
                    },
                    'StartTime': 'string',
                    'Timezone': 'string'
                },
                'SizePercent': 123,
                'State': {
                    'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
                },
                'TreatmentDescription': 'string',
                'TreatmentName': 'string'
            },
        ],
        'ApplicationId': 'string',
        'Arn': 'string',
        'CreationDate': 'string',
        'DefaultState': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
        },
        '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,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'APNSMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'BaiduMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'DefaultMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'EmailMessage': {
                'Body': 'string',
                'FromAddress': 'string',
                'HtmlBody': 'string',
                'Title': 'string'
            },
            'GCMMessage': {
                'Action': 'OPEN_APP'|'DEEP_LINK'|'URL',
                'Body': 'string',
                'ImageIconUrl': 'string',
                'ImageSmallIconUrl': 'string',
                'ImageUrl': 'string',
                'JsonBody': 'string',
                'MediaUrl': 'string',
                'RawContent': 'string',
                'SilentPush': True|False,
                'TimeToLive': 123,
                'Title': 'string',
                'Url': 'string'
            },
            'SMSMessage': {
                'Body': 'string',
                'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
                'SenderId': 'string'
            }
        },
        'Name': 'string',
        'Schedule': {
            'EndTime': 'string',
            'EventFilter': {
                'Dimensions': {
                    'Attributes': {
                        'string': {
                            'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                            'Values': [
                                'string',
                            ]
                        }
                    },
                    'EventType': {
                        'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                        'Values': [
                            'string',
                        ]
                    },
                    'Metrics': {
                        'string': {
                            'ComparisonOperator': 'string',
                            'Value': 123.0
                        }
                    }
                },
                'FilterType': 'SYSTEM'|'ENDPOINT'
            },
            'Frequency': 'ONCE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'EVENT',
            'IsLocalTime': True|False,
            'QuietTime': {
                'End': 'string',
                'Start': 'string'
            },
            'StartTime': 'string',
            'Timezone': 'string'
        },
        'SegmentId': 'string',
        'SegmentVersion': 123,
        'State': {
            'CampaignStatus': 'SCHEDULED'|'EXECUTING'|'PENDING_NEXT_RUN'|'COMPLETED'|'PAUSED'|'DELETED'
        },
        'tags': {
            'string': 'string'
        },
        'TreatmentDescription': 'string',
        'TreatmentName': 'string',
        'Version': 123
    }
}

Response Structure

(dict) -- 200 response
- 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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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) -- A URL that refers to the location of an image or video that you want to display 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.
        
        TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
        
        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.
        
        EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
        
        Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
        
        Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
        
        IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
        
        QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
        
        End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
        
        StartTime (string) -- The scheduled time 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.
  - Arn (string) -- The arn for the campaign.
  - 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 each campaign can send to a single endpoint in a 24-hour period.
    - 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 number of messages that an individual campaign can send to a single endpoint over the course of the campaign.
  - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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) -- A URL that refers to the location of an image or video that you want to display 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.
      - TimeToLive (integer) -- This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
      - 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.
    - EventFilter (dict) -- Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
      - Dimensions (dict) -- An object that defines the dimensions for the event filter.
        
        Attributes (dict) -- Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        EventType (dict) -- The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Metrics (dict) -- Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
      - FilterType (string) -- The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
    - Frequency (string) -- How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
    - IsLocalTime (boolean) -- Indicates whether the campaign schedule takes effect according to each user's local time.
    - QuietTime (dict) -- The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
      - End (string) -- The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
      - Start (string) -- The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
    - StartTime (string) -- The scheduled time 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
  - tags (dict) -- The Tags for the campaign.
    - (string) --
      - (string) --
  - 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.

UpdateSegment (updated)

Link ¶
Changes (request, response)
Request

{'WriteSegmentRequest': {'tags': {'string': 'string'}}}

Response

{'SegmentResponse': {'Arn': 'string', 'tags': {'string': 'string'}}}

Used to update a segment.

See also: AWS API Documentation

Request Syntax

client.update_segment(
    ApplicationId='string',
    SegmentId='string',
    WriteSegmentRequest={
        'Dimensions': {
            'Attributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Behavior': {
                'Recency': {
                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                    'RecencyType': 'ACTIVE'|'INACTIVE'
                }
            },
            'Demographic': {
                'AppVersion': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Channel': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'DeviceType': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Make': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Model': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Platform': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Location': {
                'Country': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'GPSPoint': {
                    'Coordinates': {
                        'Latitude': 123.0,
                        'Longitude': 123.0
                    },
                    'RangeInKilometers': 123.0
                }
            },
            'Metrics': {
                'string': {
                    'ComparisonOperator': 'string',
                    'Value': 123.0
                }
            },
            'UserAttributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            }
        },
        'Name': 'string',
        'SegmentGroups': {
            'Groups': [
                {
                    'Dimensions': [
                        {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Behavior': {
                                'Recency': {
                                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                    'RecencyType': 'ACTIVE'|'INACTIVE'
                                }
                            },
                            'Demographic': {
                                'AppVersion': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Channel': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'DeviceType': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Make': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Model': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Platform': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Location': {
                                'Country': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'GPSPoint': {
                                    'Coordinates': {
                                        'Latitude': 123.0,
                                        'Longitude': 123.0
                                    },
                                    'RangeInKilometers': 123.0
                                }
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            },
                            'UserAttributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            }
                        },
                    ],
                    'SourceSegments': [
                        {
                            'Id': 'string',
                            'Version': 123
                        },
                    ],
                    'SourceType': 'ALL'|'ANY'|'NONE',
                    'Type': 'ALL'|'ANY'|'NONE'
                },
            ],
            'Include': 'ALL'|'ANY'|'NONE'
        },
        'tags': {
            'string': 'string'
        }
    }
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED] The unique ID of your Amazon Pinpoint application.

type SegmentId:

string

param SegmentId:

[REQUIRED] The unique ID of the segment.

type WriteSegmentRequest:

dict

param WriteSegmentRequest:

[REQUIRED] Segment definition.

Dimensions (dict) -- The segment dimensions attributes.
- Attributes (dict) -- Custom segment attributes.
  - (string) --
    - (dict) -- Custom attibute dimension
      - AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
      - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
- Behavior (dict) -- The segment behaviors attributes.
  - Recency (dict) -- The recency of use.
    - Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
    - RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
- Demographic (dict) -- The segment demographics attributes.
  - AppVersion (dict) -- The app version criteria for the segment.
    - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
      - (string) --
  - Channel (dict) -- The channel criteria for the segment.
    - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
      - (string) --
  - DeviceType (dict) -- The device type criteria for the segment.
    - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
      - (string) --
  - Make (dict) -- The device make criteria for the segment.
    - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
      - (string) --
  - Model (dict) -- The device model criteria for the segment.
    - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
      - (string) --
  - Platform (dict) -- The device platform criteria for the segment.
    - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
      - (string) --
- Location (dict) -- The segment location attributes.
  - Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
    - DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
      - (string) --
  - GPSPoint (dict) -- The GPS Point dimension.
    - Coordinates (dict) -- Coordinate to measure distance from.
      - Latitude (float) -- Latitude
      - Longitude (float) -- Longitude
    - RangeInKilometers (float) -- Range in kilometers from the coordinate.
- Metrics (dict) -- Custom segment metrics.
  - (string) --
    - (dict) -- Custom metric dimension
      - ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
      - Value (float) -- The value to be compared.
- UserAttributes (dict) -- Custom segment user attributes.
  - (string) --
    - (dict) -- Custom attibute dimension
      - AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
      - Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
Name (string) -- The name of segment
SegmentGroups (dict) -- A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments. Your request can only include one segment group. Your request can include either a SegmentGroups object or a Dimensions object, but not both.
- Groups (list) -- A set of segment criteria to evaluate.
  - (dict) -- Segment group definition.
    - Dimensions (list) -- List of dimensions to include or exclude.
      - (dict) -- Segment dimensions
        
        Attributes (dict) -- Custom segment attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Behavior (dict) -- The segment behaviors attributes.
        
        Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
        
        Demographic (dict) -- The segment demographics attributes.
        
        AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Location (dict) -- The segment location attributes.
        
        Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
        
        Metrics (dict) -- Custom segment metrics.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        UserAttributes (dict) -- Custom segment user attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - SourceSegments (list) -- The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
      - (dict) -- Segment reference.
        
        Id (string) -- A unique identifier for the segment.
        
        Version (integer) -- If specified contains a specific version of the segment included.
    - SourceType (string) -- Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.
    - Type (string) -- Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.
- Include (string) -- Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE.
tags (dict) -- The Tags for the segments.
- (string) --
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'SegmentResponse': {
        'ApplicationId': 'string',
        'Arn': 'string',
        'CreationDate': 'string',
        'Dimensions': {
            'Attributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Behavior': {
                'Recency': {
                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                    'RecencyType': 'ACTIVE'|'INACTIVE'
                }
            },
            'Demographic': {
                'AppVersion': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Channel': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'DeviceType': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Make': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Model': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'Platform': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            },
            'Location': {
                'Country': {
                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                },
                'GPSPoint': {
                    'Coordinates': {
                        'Latitude': 123.0,
                        'Longitude': 123.0
                    },
                    'RangeInKilometers': 123.0
                }
            },
            'Metrics': {
                'string': {
                    'ComparisonOperator': 'string',
                    'Value': 123.0
                }
            },
            'UserAttributes': {
                'string': {
                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                    'Values': [
                        'string',
                    ]
                }
            }
        },
        'Id': 'string',
        'ImportDefinition': {
            'ChannelCounts': {
                'string': 123
            },
            'ExternalId': 'string',
            'Format': 'CSV'|'JSON',
            'RoleArn': 'string',
            'S3Url': 'string',
            'Size': 123
        },
        'LastModifiedDate': 'string',
        'Name': 'string',
        'SegmentGroups': {
            'Groups': [
                {
                    'Dimensions': [
                        {
                            'Attributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Behavior': {
                                'Recency': {
                                    'Duration': 'HR_24'|'DAY_7'|'DAY_14'|'DAY_30',
                                    'RecencyType': 'ACTIVE'|'INACTIVE'
                                }
                            },
                            'Demographic': {
                                'AppVersion': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Channel': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'DeviceType': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Make': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Model': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'Platform': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            },
                            'Location': {
                                'Country': {
                                    'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                },
                                'GPSPoint': {
                                    'Coordinates': {
                                        'Latitude': 123.0,
                                        'Longitude': 123.0
                                    },
                                    'RangeInKilometers': 123.0
                                }
                            },
                            'Metrics': {
                                'string': {
                                    'ComparisonOperator': 'string',
                                    'Value': 123.0
                                }
                            },
                            'UserAttributes': {
                                'string': {
                                    'AttributeType': 'INCLUSIVE'|'EXCLUSIVE',
                                    'Values': [
                                        'string',
                                    ]
                                }
                            }
                        },
                    ],
                    'SourceSegments': [
                        {
                            'Id': 'string',
                            'Version': 123
                        },
                    ],
                    'SourceType': 'ALL'|'ANY'|'NONE',
                    'Type': 'ALL'|'ANY'|'NONE'
                },
            ],
            'Include': 'ALL'|'ANY'|'NONE'
        },
        'SegmentType': 'DIMENSIONAL'|'IMPORT',
        'tags': {
            'string': 'string'
        },
        'Version': 123
    }
}

Response Structure

(dict) -- 200 response
- SegmentResponse (dict) -- Segment definition.
  - ApplicationId (string) -- The ID of the application that the segment applies to.
  - Arn (string) -- The arn for the segment.
  - CreationDate (string) -- The date and time when the segment was created.
  - Dimensions (dict) -- The segment dimensions attributes.
    - Attributes (dict) -- Custom segment attributes.
      - (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - Behavior (dict) -- The segment behaviors attributes.
      - Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
    - Demographic (dict) -- The segment demographics attributes.
      - AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
    - Location (dict) -- The segment location attributes.
      - Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
      - GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
    - Metrics (dict) -- Custom segment metrics.
      - (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
    - UserAttributes (dict) -- Custom segment user attributes.
      - (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
  - Id (string) -- The unique segment ID.
  - ImportDefinition (dict) -- The import job settings.
    - ChannelCounts (dict) -- The number of channel types in the imported segment.
      - (string) --
        
        (integer) --
    - ExternalId (string) -- (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
    - Format (string) -- The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
    - RoleArn (string) -- The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
    - S3Url (string) -- The URL of the S3 bucket that the segment was imported from.
    - Size (integer) -- The number of endpoints that were successfully imported to create this segment.
  - LastModifiedDate (string) -- The date and time when the segment was last modified.
  - Name (string) -- The name of the segment.
  - SegmentGroups (dict) -- A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
    - Groups (list) -- A set of segment criteria to evaluate.
      - (dict) -- Segment group definition.
        
        Dimensions (list) -- List of dimensions to include or exclude.
        
        (dict) -- Segment dimensions
        
        Attributes (dict) -- Custom segment attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Behavior (dict) -- The segment behaviors attributes.
        
        Recency (dict) -- The recency of use.
        
        Duration (string) -- The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
        
        RecencyType (string) -- The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
        
        Demographic (dict) -- The segment demographics attributes.
        
        AppVersion (dict) -- The app version criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Channel (dict) -- The channel criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        DeviceType (dict) -- The device type criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Make (dict) -- The device make criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Model (dict) -- The device model criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Platform (dict) -- The device platform criteria for the segment.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        Location (dict) -- The segment location attributes.
        
        Country (dict) -- The country or region, in ISO 3166-1 alpha-2 format.
        
        DimensionType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        GPSPoint (dict) -- The GPS Point dimension.
        
        Coordinates (dict) -- Coordinate to measure distance from.
        
        Latitude (float) -- Latitude
        
        Longitude (float) -- Longitude
        
        RangeInKilometers (float) -- Range in kilometers from the coordinate.
        
        Metrics (dict) -- Custom segment metrics.
        
        (string) --
        
        (dict) -- Custom metric dimension
        
        ComparisonOperator (string) -- The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
        
        Value (float) -- The value to be compared.
        
        UserAttributes (dict) -- Custom segment user attributes.
        
        (string) --
        
        (dict) -- Custom attibute dimension
        
        AttributeType (string) -- The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
        
        Values (list) -- The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
        
        (string) --
        
        SourceSegments (list) -- The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
        
        (dict) -- Segment reference.
        
        Id (string) -- A unique identifier for the segment.
        
        Version (integer) -- If specified contains a specific version of the segment included.
        
        SourceType (string) -- Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.
        
        Type (string) -- Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.
    - Include (string) -- Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE.
  - SegmentType (string) -- The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
  - tags (dict) -- The Tags for the segment.
    - (string) --
      - (string) --
  - Version (integer) -- The segment version number.