route/vendor/github.com/aws/aws-sdk-go/models/apis/pinpoint/2016-12-01/docs-2.json

1096 lines
72 KiB
JSON

{
"version" : "2.0",
"service" : null,
"operations" : {
"CreateApp" : "Creates or updates an app.",
"CreateCampaign" : "Creates or updates a campaign.",
"CreateImportJob" : "Creates or updates an import job.",
"CreateSegment" : "Used to create or update a segment.",
"DeleteAdmChannel" : "Delete an ADM channel",
"DeleteApnsChannel" : "Deletes the APNs channel for an app.",
"DeleteApnsSandboxChannel" : "Delete an APNS sandbox channel",
"DeleteApnsVoipChannel" : "Delete an APNS VOIP channel",
"DeleteApnsVoipSandboxChannel" : "Delete an APNS VOIP sandbox channel",
"DeleteApp" : "Deletes an app.",
"DeleteBaiduChannel" : "Delete a BAIDU GCM channel",
"DeleteCampaign" : "Deletes a campaign.",
"DeleteEmailChannel" : "Delete an email channel",
"DeleteEventStream" : "Deletes the event stream for an app.",
"DeleteGcmChannel" : "Deletes the GCM channel for an app.",
"DeleteSegment" : "Deletes a segment.",
"DeleteSmsChannel" : "Delete an SMS channel",
"GetAdmChannel" : "Get an ADM channel",
"GetApnsChannel" : "Returns information about the APNs channel for an app.",
"GetApnsSandboxChannel" : "Get an APNS sandbox channel",
"GetApnsVoipChannel" : "Get an APNS Voip channel",
"GetApnsVoipSandboxChannel" : "Get an APNS VoipSandbox channel",
"GetApp" : "Returns information about an app.",
"GetApplicationSettings" : "Used to request the settings for an app.",
"GetApps" : "Returns information about your apps.",
"GetBaiduChannel" : "Get a BAIDU GCM channel",
"GetCampaign" : "Returns information about a campaign.",
"GetCampaignActivities" : "Returns information about the activity performed by a campaign.",
"GetCampaignVersion" : "Returns information about a specific version of a campaign.",
"GetCampaignVersions" : "Returns information about your campaign versions.",
"GetCampaigns" : "Returns information about your campaigns.",
"GetEmailChannel" : "Get an email channel",
"GetEndpoint" : "Returns information about an endpoint.",
"GetEventStream" : "Returns the event stream for an app.",
"GetGcmChannel" : "Returns information about the GCM channel for an app.",
"GetImportJob" : "Returns information about an import job.",
"GetImportJobs" : "Returns information about your import jobs.",
"GetSegment" : "Returns information about a segment.",
"GetSegmentImportJobs" : "Returns a list of import jobs for a specific segment.",
"GetSegmentVersion" : "Returns information about a segment version.",
"GetSegmentVersions" : "Returns information about your segment versions.",
"GetSegments" : "Used to get information about your segments.",
"GetSmsChannel" : "Get an SMS channel",
"PutEventStream" : "Use to create or update the event stream for an app.",
"SendMessages" : "Send a batch of messages",
"SendUsersMessages" : "Send a batch of messages to users",
"UpdateAdmChannel" : "Update an ADM channel",
"UpdateApnsChannel" : "Use to update the APNs channel for an app.",
"UpdateApnsSandboxChannel" : "Update an APNS sandbox channel",
"UpdateApnsVoipChannel" : "Update an APNS VOIP channel",
"UpdateApnsVoipSandboxChannel" : "Update an APNS VOIP sandbox channel",
"UpdateApplicationSettings" : "Used to update the settings for an app.",
"UpdateBaiduChannel" : "Update a BAIDU GCM channel",
"UpdateCampaign" : "Use to update a campaign.",
"UpdateEmailChannel" : "Update an email channel",
"UpdateEndpoint" : "Use to update an endpoint.",
"UpdateEndpointsBatch" : "Use to update a batch of endpoints.",
"UpdateGcmChannel" : "Use to update the GCM channel for an app.",
"UpdateSegment" : "Use to update a segment.",
"UpdateSmsChannel" : "Update an SMS channel"
},
"shapes" : {
"ADMChannelRequest" : {
"base" : "Amazon Device Messaging channel definition.",
"refs" : { }
},
"ADMChannelResponse" : {
"base" : "Amazon Device Messaging channel definition.",
"refs" : { }
},
"ADMMessage" : {
"base" : "ADM Message.",
"refs" : {
"DirectMessageConfiguration$ADMMessage" : "The message to ADM channels. Overrides the default push notification message."
}
},
"APNSChannelRequest" : {
"base" : "Apple Push Notification Service channel definition.",
"refs" : { }
},
"APNSChannelResponse" : {
"base" : "Apple Distribution Push Notification Service channel definition.",
"refs" : { }
},
"APNSMessage" : {
"base" : "APNS Message.",
"refs" : {
"DirectMessageConfiguration$APNSMessage" : "The message to APNS channels. Overrides the default push notification message."
}
},
"APNSSandboxChannelRequest" : {
"base" : "Apple Development Push Notification Service channel definition.",
"refs" : { }
},
"APNSSandboxChannelResponse" : {
"base" : "Apple Development Push Notification Service channel definition.",
"refs" : { }
},
"APNSVoipChannelRequest" : {
"base" : "Apple VOIP Push Notification Service channel definition.",
"refs" : { }
},
"APNSVoipChannelResponse" : {
"base" : "Apple VOIP Push Notification Service channel definition.",
"refs" : { }
},
"APNSVoipSandboxChannelRequest" : {
"base" : "Apple VOIP Developer Push Notification Service channel definition.",
"refs" : { }
},
"APNSVoipSandboxChannelResponse" : {
"base" : "Apple VOIP Developer Push Notification Service channel definition.",
"refs" : { }
},
"Action" : {
"base" : null,
"refs" : {
"ADMMessage$Action" : "The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL",
"APNSMessage$Action" : "The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL",
"BaiduMessage$Action" : "The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL",
"DefaultPushNotificationMessage$Action" : "The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL",
"GCMMessage$Action" : "The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL",
"Message$Action" : "The action that occurs if the user taps a push notification delivered by the campaign:\nOPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.\n\nDEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.\n\nURL - The default mobile browser on the user's device launches and opens a web page at the URL you specify."
}
},
"ActivitiesResponse" : {
"base" : "Activities for campaign.",
"refs" : { }
},
"ActivityResponse" : {
"base" : "Activity definition",
"refs" : {
"ActivitiesResponse$Item" : "List of campaign activities"
}
},
"AddressConfiguration" : {
"base" : "Address configuration.",
"refs" : {
"MessageRequest$Addresses" : "A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value."
}
},
"ApplicationResponse" : {
"base" : "Application Response.",
"refs" : {
"ApplicationsResponse$Item" : "List of applications returned in this page."
}
},
"ApplicationSettingsResource" : {
"base" : "Application settings.",
"refs" : { }
},
"ApplicationsResponse" : {
"base" : "Get Applications Result.",
"refs" : { }
},
"AttributeDimension" : {
"base" : "Custom attibute dimension",
"refs" : {
"SegmentDimensions$Attributes" : "Custom segment attributes.",
"SegmentDimensions$UserAttributes" : "Custom segment user attributes."
}
},
"AttributeType" : {
"base" : null,
"refs" : {
"AttributeDimension$AttributeType" : "The type of dimension:\nINCLUSIVE - Endpoints that match the criteria are included in the segment.\nEXCLUSIVE - Endpoints that match the criteria are excluded from the segment."
}
},
"BadRequestException" : {
"base" : null,
"refs" : { }
},
"BaiduChannelRequest" : {
"base" : "Baidu Cloud Push credentials",
"refs" : { }
},
"BaiduChannelResponse" : {
"base" : "Baidu Cloud Messaging channel definition",
"refs" : { }
},
"BaiduMessage" : {
"base" : "Baidu Message.",
"refs" : {
"DirectMessageConfiguration$BaiduMessage" : "The message to Baidu GCM channels. Overrides the default push notification message."
}
},
"CampaignEmailMessage" : {
"base" : "The email message configuration.",
"refs" : {
"MessageConfiguration$EmailMessage" : "The email message configuration."
}
},
"CampaignLimits" : {
"base" : "Campaign Limits are used to limit the number of messages that can be sent to a user.",
"refs" : {
"ApplicationSettingsResource$Limits" : "The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.",
"CampaignResponse$Limits" : "The campaign limits settings.",
"WriteApplicationSettingsRequest$Limits" : "The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.",
"WriteCampaignRequest$Limits" : "The campaign limits settings."
}
},
"CampaignResponse" : {
"base" : "Campaign definition",
"refs" : {
"CampaignsResponse$Item" : "A list of campaigns."
}
},
"CampaignSmsMessage" : {
"base" : "SMS message configuration.",
"refs" : {
"MessageConfiguration$SMSMessage" : "The SMS message configuration."
}
},
"CampaignState" : {
"base" : "State of the Campaign",
"refs" : {
"CampaignResponse$DefaultState" : "The status of the campaign's default treatment. Only present for A/B test campaigns.",
"CampaignResponse$State" : "The campaign status.\n\nAn A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.",
"TreatmentResource$State" : "The treatment status."
}
},
"CampaignStatus" : {
"base" : null,
"refs" : {
"CampaignState$CampaignStatus" : "The status of the campaign, or the status of a treatment that belongs to an A/B test campaign.\n\nValid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED"
}
},
"CampaignsResponse" : {
"base" : "List of available campaigns.",
"refs" : { }
},
"ChannelType" : {
"base" : null,
"refs" : {
"AddressConfiguration$ChannelType" : "The channel type.\n\nValid values: GCM | APNS | SMS | EMAIL",
"EndpointBatchItem$ChannelType" : "The channel type.\n\nValid values: GCM | APNS | SMS | EMAIL",
"EndpointRequest$ChannelType" : "The channel type.\n\nValid values: GCM | APNS | SMS | EMAIL",
"EndpointResponse$ChannelType" : "The channel type.\n\nValid values: GCM | APNS | SMS | EMAIL"
}
},
"CreateApplicationRequest" : {
"base" : "Application Request.",
"refs" : { }
},
"DefaultMessage" : {
"base" : "Default Message across push notification, email, and sms.",
"refs" : {
"DirectMessageConfiguration$DefaultMessage" : "The default message for all channels."
}
},
"DefaultPushNotificationMessage" : {
"base" : "Default Push Notification Message.",
"refs" : {
"DirectMessageConfiguration$DefaultPushNotificationMessage" : "The default push notification message for all push channels."
}
},
"DeliveryStatus" : {
"base" : null,
"refs" : {
"EndpointMessageResult$DeliveryStatus" : "Delivery status of message.",
"MessageResult$DeliveryStatus" : "Delivery status of message."
}
},
"DimensionType" : {
"base" : null,
"refs" : {
"SetDimension$DimensionType" : "The type of dimension:\nINCLUSIVE - Endpoints that match the criteria are included in the segment.\nEXCLUSIVE - Endpoints that match the criteria are excluded from the segment."
}
},
"DirectMessageConfiguration" : {
"base" : "The message configuration.",
"refs" : {
"MessageRequest$MessageConfiguration" : "Message configuration.",
"SendUsersMessageRequest$MessageConfiguration" : "Message configuration."
}
},
"Duration" : {
"base" : null,
"refs" : {
"RecencyDimension$Duration" : "The length of time during which users have been active or inactive with your app.\nValid values: HR_24, DAY_7, DAY_14, DAY_30"
}
},
"EmailChannelRequest" : {
"base" : "Email Channel Request",
"refs" : { }
},
"EmailChannelResponse" : {
"base" : "Email Channel Response.",
"refs" : { }
},
"EndpointBatchItem" : {
"base" : "Endpoint update request",
"refs" : {
"EndpointBatchRequest$Item" : "List of items to update. Maximum 100 items"
}
},
"EndpointBatchRequest" : {
"base" : "Endpoint batch update request.",
"refs" : { }
},
"EndpointDemographic" : {
"base" : "Endpoint demographic data",
"refs" : {
"EndpointBatchItem$Demographic" : "The endpoint demographic attributes.",
"EndpointRequest$Demographic" : "The endpoint demographic attributes.",
"EndpointResponse$Demographic" : "The endpoint demographic attributes."
}
},
"EndpointLocation" : {
"base" : "Endpoint location data",
"refs" : {
"EndpointBatchItem$Location" : "The endpoint location attributes.",
"EndpointRequest$Location" : "The endpoint location attributes.",
"EndpointResponse$Location" : "The endpoint location attributes."
}
},
"EndpointMessageResult" : {
"base" : "The result from sending a message to an endpoint.",
"refs" : {
"MessageResponse$EndpointResult" : "A map containing a multi part response for each address, with the endpointId as the key and the result as the value.",
"SendUsersMessageResponse$Result" : "A map containing of UserId to Map of EndpointId to Endpoint Message Result."
}
},
"EndpointRequest" : {
"base" : "Endpoint update request",
"refs" : { }
},
"EndpointResponse" : {
"base" : "Endpoint response",
"refs" : { }
},
"EndpointSendConfiguration" : {
"base" : "Endpoint send configuration.",
"refs" : {
"MessageRequest$Endpoints" : "A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.",
"SendUsersMessageRequest$Users" : "A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value."
}
},
"EndpointUser" : {
"base" : "Endpoint user specific custom userAttributes",
"refs" : {
"EndpointBatchItem$User" : "Custom user-specific attributes that your app reports to Amazon Pinpoint.",
"EndpointRequest$User" : "Custom user-specific attributes that your app reports to Amazon Pinpoint.",
"EndpointResponse$User" : "Custom user-specific attributes that your app reports to Amazon Pinpoint."
}
},
"EventStream" : {
"base" : "Model for an event publishing subscription export.",
"refs" : { }
},
"ForbiddenException" : {
"base" : null,
"refs" : { }
},
"Format" : {
"base" : null,
"refs" : {
"ImportJobRequest$Format" : "The format of the files that contain the endpoint definitions.\nValid values: CSV, JSON",
"ImportJobResource$Format" : "The format of the files that contain the endpoint definitions.\nValid values: CSV, JSON",
"SegmentImportResource$Format" : "The format of the endpoint files that were imported to create this segment.\nValid values: CSV, JSON"
}
},
"Frequency" : {
"base" : null,
"refs" : {
"Schedule$Frequency" : "How often the campaign delivers messages.\n\nValid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY"
}
},
"GCMChannelRequest" : {
"base" : "Google Cloud Messaging credentials",
"refs" : { }
},
"GCMChannelResponse" : {
"base" : "Google Cloud Messaging channel definition",
"refs" : { }
},
"GCMMessage" : {
"base" : "GCM Message.",
"refs" : {
"DirectMessageConfiguration$GCMMessage" : "The message to GCM channels. Overrides the default push notification message."
}
},
"ImportJobRequest" : {
"base" : null,
"refs" : { }
},
"ImportJobResource" : {
"base" : null,
"refs" : {
"ImportJobResponse$Definition" : "The import job settings."
}
},
"ImportJobResponse" : {
"base" : null,
"refs" : {
"ImportJobsResponse$Item" : "A list of import jobs for the application."
}
},
"ImportJobsResponse" : {
"base" : "Import job list.",
"refs" : { }
},
"InternalServerErrorException" : {
"base" : null,
"refs" : { }
},
"JobStatus" : {
"base" : null,
"refs" : {
"ImportJobResponse$JobStatus" : "The status of the import job.\nValid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED\n\nThe job status is FAILED if one or more pieces failed to import."
}
},
"ListOfActivityResponse" : {
"base" : null,
"refs" : { }
},
"ListOfApplicationResponse" : {
"base" : null,
"refs" : { }
},
"ListOfCampaignResponse" : {
"base" : null,
"refs" : { }
},
"ListOfEndpointBatchItem" : {
"base" : null,
"refs" : { }
},
"ListOfImportJobResponse" : {
"base" : null,
"refs" : { }
},
"ListOfSegmentResponse" : {
"base" : null,
"refs" : { }
},
"ListOfTreatmentResource" : {
"base" : null,
"refs" : { }
},
"ListOfWriteTreatmentResource" : {
"base" : null,
"refs" : { }
},
"ListOf__string" : {
"base" : null,
"refs" : { }
},
"MapOfAddressConfiguration" : {
"base" : null,
"refs" : { }
},
"MapOfAttributeDimension" : {
"base" : null,
"refs" : { }
},
"MapOfEndpointMessageResult" : {
"base" : null,
"refs" : { }
},
"MapOfEndpointSendConfiguration" : {
"base" : null,
"refs" : { }
},
"MapOfListOf__string" : {
"base" : null,
"refs" : { }
},
"MapOfMapOfEndpointMessageResult" : {
"base" : null,
"refs" : { }
},
"MapOfMessageResult" : {
"base" : null,
"refs" : { }
},
"MapOf__double" : {
"base" : null,
"refs" : { }
},
"MapOf__integer" : {
"base" : null,
"refs" : { }
},
"MapOf__string" : {
"base" : null,
"refs" : { }
},
"Message" : {
"base" : null,
"refs" : {
"MessageConfiguration$ADMMessage" : "The message that the campaign delivers to ADM channels. Overrides the default message.",
"MessageConfiguration$APNSMessage" : "The message that the campaign delivers to APNS channels. Overrides the default message.",
"MessageConfiguration$BaiduMessage" : "The message that the campaign delivers to Baidu channels. Overrides the default message.",
"MessageConfiguration$DefaultMessage" : "The default message for all channels.",
"MessageConfiguration$GCMMessage" : "The message that the campaign delivers to GCM channels. Overrides the default message."
}
},
"MessageBody" : {
"base" : "Simple message object.",
"refs" : { }
},
"MessageConfiguration" : {
"base" : "Message configuration for a campaign.",
"refs" : {
"CampaignResponse$MessageConfiguration" : "The message configuration settings.",
"TreatmentResource$MessageConfiguration" : "The message configuration settings.",
"WriteCampaignRequest$MessageConfiguration" : "The message configuration settings.",
"WriteTreatmentResource$MessageConfiguration" : "The message configuration settings."
}
},
"MessageRequest" : {
"base" : "Send message request.",
"refs" : { }
},
"MessageResponse" : {
"base" : "Send message response.",
"refs" : { }
},
"MessageResult" : {
"base" : "The result from sending a message to an address.",
"refs" : {
"MessageResponse$Result" : "A map containing a multi part response for each address, with the address as the key(Email address, phone number or push token) and the result as the value."
}
},
"MessageType" : {
"base" : null,
"refs" : {
"CampaignSmsMessage$MessageType" : "Is this is a transactional SMS message, otherwise a promotional message.",
"SMSMessage$MessageType" : "Is this a transaction priority message or lower priority."
}
},
"MethodNotAllowedException" : {
"base" : null,
"refs" : { }
},
"NotFoundException" : {
"base" : null,
"refs" : { }
},
"QuietTime" : {
"base" : "Quiet Time",
"refs" : {
"ApplicationSettingsResource$QuietTime" : "The default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own.",
"Schedule$QuietTime" : "The time during which the campaign sends no messages.",
"WriteApplicationSettingsRequest$QuietTime" : "The default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own."
}
},
"RecencyDimension" : {
"base" : "Define how a segment based on recency of use.",
"refs" : {
"SegmentBehaviors$Recency" : "The recency of use."
}
},
"RecencyType" : {
"base" : null,
"refs" : {
"RecencyDimension$RecencyType" : "The recency dimension type:\nACTIVE - Users who have used your app within the specified duration are included in the segment.\nINACTIVE - Users who have not used your app within the specified duration are included in the segment."
}
},
"SMSChannelRequest" : {
"base" : "SMS Channel Request",
"refs" : { }
},
"SMSChannelResponse" : {
"base" : "SMS Channel Response.",
"refs" : { }
},
"SMSMessage" : {
"base" : "SMS Message.",
"refs" : {
"DirectMessageConfiguration$SMSMessage" : "The message to SMS channels. Overrides the default message."
}
},
"Schedule" : {
"base" : "Shcedule that defines when a campaign is run.",
"refs" : {
"CampaignResponse$Schedule" : "The campaign schedule.",
"TreatmentResource$Schedule" : "The campaign schedule.",
"WriteCampaignRequest$Schedule" : "The campaign schedule.",
"WriteTreatmentResource$Schedule" : "The campaign schedule."
}
},
"SegmentBehaviors" : {
"base" : "Segment behavior dimensions",
"refs" : {
"SegmentDimensions$Behavior" : "The segment behaviors attributes."
}
},
"SegmentDemographics" : {
"base" : "Segment demographic dimensions",
"refs" : {
"SegmentDimensions$Demographic" : "The segment demographics attributes."
}
},
"SegmentDimensions" : {
"base" : "Segment dimensions",
"refs" : {
"SegmentResponse$Dimensions" : "The segment dimensions attributes.",
"WriteSegmentRequest$Dimensions" : "The segment dimensions attributes."
}
},
"SegmentImportResource" : {
"base" : "Segment import definition.",
"refs" : {
"SegmentResponse$ImportDefinition" : "The import job settings."
}
},
"SegmentLocation" : {
"base" : "Segment location dimensions",
"refs" : {
"SegmentDimensions$Location" : "The segment location attributes."
}
},
"SegmentResponse" : {
"base" : "Segment definition.",
"refs" : {
"SegmentsResponse$Item" : "The list of segments."
}
},
"SegmentType" : {
"base" : null,
"refs" : {
"SegmentResponse$SegmentType" : "The segment type:\nDIMENSIONAL - 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.\nIMPORT - 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."
}
},
"SegmentsResponse" : {
"base" : "Segments in your account.",
"refs" : { }
},
"SendUsersMessageRequest" : {
"base" : "Send message request.",
"refs" : { }
},
"SendUsersMessageResponse" : {
"base" : "User send message response.",
"refs" : { }
},
"SetDimension" : {
"base" : "Dimension specification of a segment.",
"refs" : {
"SegmentDemographics$AppVersion" : "The app version criteria for the segment.",
"SegmentDemographics$Channel" : "The channel criteria for the segment.",
"SegmentDemographics$DeviceType" : "The device type criteria for the segment.",
"SegmentDemographics$Make" : "The device make criteria for the segment.",
"SegmentDemographics$Model" : "The device model criteria for the segment.",
"SegmentDemographics$Platform" : "The device platform criteria for the segment.",
"SegmentLocation$Country" : "The country filter according to ISO 3166-1 Alpha-2 codes."
}
},
"TooManyRequestsException" : {
"base" : null,
"refs" : { }
},
"TreatmentResource" : {
"base" : "Treatment resource",
"refs" : {
"CampaignResponse$AdditionalTreatments" : "Treatments that are defined in addition to the default treatment."
}
},
"WriteApplicationSettingsRequest" : {
"base" : "Creating application setting request",
"refs" : { }
},
"WriteCampaignRequest" : {
"base" : "Used to create a campaign.",
"refs" : { }
},
"WriteEventStream" : {
"base" : "Request to save an EventStream.",
"refs" : { }
},
"WriteSegmentRequest" : {
"base" : "Segment definition.",
"refs" : { }
},
"WriteTreatmentResource" : {
"base" : "Used to create a campaign treatment.",
"refs" : {
"WriteCampaignRequest$AdditionalTreatments" : "Treatments that are defined in addition to the default treatment."
}
},
"__boolean" : {
"base" : null,
"refs" : {
"ADMChannelRequest$Enabled" : "If the channel is enabled for sending messages.",
"ADMChannelResponse$Enabled" : "If the channel is enabled for sending messages.",
"ADMChannelResponse$HasCredential" : "If the channel is registered with a credential for authentication.",
"ADMChannelResponse$IsArchived" : "Is this channel archived",
"ADMMessage$SilentPush" : "Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.",
"APNSChannelRequest$Enabled" : "If the channel is enabled for sending messages.",
"APNSChannelResponse$Enabled" : "If the channel is enabled for sending messages.",
"APNSChannelResponse$HasCredential" : "If the channel is registered with a credential for authentication.",
"APNSChannelResponse$HasTokenKey" : "If the channel is registered with a token key for authentication.",
"APNSChannelResponse$IsArchived" : "Is this channel archived",
"APNSMessage$SilentPush" : "Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.",
"APNSSandboxChannelRequest$Enabled" : "If the channel is enabled for sending messages.",
"APNSSandboxChannelResponse$Enabled" : "If the channel is enabled for sending messages.",
"APNSSandboxChannelResponse$HasCredential" : "If the channel is registered with a credential for authentication.",
"APNSSandboxChannelResponse$HasTokenKey" : "If the channel is registered with a token key for authentication.",
"APNSSandboxChannelResponse$IsArchived" : "Is this channel archived",
"APNSVoipChannelRequest$Enabled" : "If the channel is enabled for sending messages.",
"APNSVoipChannelResponse$Enabled" : "If the channel is enabled for sending messages.",
"APNSVoipChannelResponse$HasCredential" : "If the channel is registered with a credential for authentication.",
"APNSVoipChannelResponse$HasTokenKey" : "If the channel is registered with a token key for authentication.",
"APNSVoipChannelResponse$IsArchived" : "Is this channel archived",
"APNSVoipSandboxChannelRequest$Enabled" : "If the channel is enabled for sending messages.",
"APNSVoipSandboxChannelResponse$Enabled" : "If the channel is enabled for sending messages.",
"APNSVoipSandboxChannelResponse$HasCredential" : "If the channel is registered with a credential for authentication.",
"APNSVoipSandboxChannelResponse$HasTokenKey" : "If the channel is registered with a token key for authentication.",
"APNSVoipSandboxChannelResponse$IsArchived" : "Is this channel archived",
"BaiduChannelRequest$Enabled" : "If the channel is enabled for sending messages.",
"BaiduChannelResponse$Enabled" : "If the channel is enabled for sending messages.",
"BaiduChannelResponse$HasCredential" : "If the channel is registered with a credential for authentication.",
"BaiduChannelResponse$IsArchived" : "Is this channel archived",
"BaiduMessage$SilentPush" : "Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.",
"CampaignResponse$IsPaused" : "Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.",
"DefaultPushNotificationMessage$SilentPush" : "Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.",
"EmailChannelRequest$Enabled" : "If the channel is enabled for sending messages.",
"EmailChannelResponse$Enabled" : "If the channel is enabled for sending messages.",
"EmailChannelResponse$HasCredential" : "If the channel is registered with a credential for authentication.",
"EmailChannelResponse$IsArchived" : "Is this channel archived",
"GCMChannelRequest$Enabled" : "If the channel is enabled for sending messages.",
"GCMChannelResponse$Enabled" : "If the channel is enabled for sending messages.",
"GCMChannelResponse$HasCredential" : "If the channel is registered with a credential for authentication.",
"GCMChannelResponse$IsArchived" : "Is this channel archived",
"GCMMessage$SilentPush" : "Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.",
"ImportJobRequest$DefineSegment" : "Sets whether the endpoints create a segment when they are imported.",
"ImportJobRequest$RegisterEndpoints" : "Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.",
"ImportJobResource$DefineSegment" : "Sets whether the endpoints create a segment when they are imported.",
"ImportJobResource$RegisterEndpoints" : "Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.",
"Message$SilentPush" : "Indicates if the message should display on the users device.\n\nSilent pushes can be used for Remote Configuration and Phone Home use cases. ",
"SMSChannelRequest$Enabled" : "If the channel is enabled for sending messages.",
"SMSChannelResponse$Enabled" : "If the channel is enabled for sending messages.",
"SMSChannelResponse$HasCredential" : "If the channel is registered with a credential for authentication.",
"SMSChannelResponse$IsArchived" : "Is this channel archived",
"Schedule$IsLocalTime" : "Indicates whether the campaign schedule takes effect according to each user's local time.",
"WriteCampaignRequest$IsPaused" : "Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false."
}
},
"__double" : {
"base" : null,
"refs" : {
"EndpointLocation$Latitude" : "The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).",
"EndpointLocation$Longitude" : "The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile)."
}
},
"__integer" : {
"base" : null,
"refs" : {
"ADMChannelResponse$Version" : "Version of channel",
"APNSChannelResponse$Version" : "Version of channel",
"APNSMessage$Badge" : "Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.",
"APNSMessage$TimeToLive" : "This parameter specifies how long (in seconds) the message should be kept if APNS is unable to deliver the notification the first time. If the value is 0, APNS 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 APNS",
"APNSSandboxChannelResponse$Version" : "Version of channel",
"APNSVoipChannelResponse$Version" : "Version of channel",
"APNSVoipSandboxChannelResponse$Version" : "Version of channel",
"ActivityResponse$SuccessfulEndpointCount" : "The total number of endpoints to which the campaign successfully delivered messages.",
"ActivityResponse$TimezonesCompletedCount" : "The total number of timezones completed.",
"ActivityResponse$TimezonesTotalCount" : "The total number of unique timezones present in the segment.",
"ActivityResponse$TotalEndpointCount" : "The total number of endpoints to which the campaign attempts to deliver messages.",
"BaiduChannelResponse$Version" : "Version of channel",
"CampaignLimits$Daily" : "The maximum number of messages that the campaign can send daily.",
"CampaignLimits$MaximumDuration" : "The maximum duration of a campaign from the scheduled start. Must be a minimum of 60 seconds.",
"CampaignLimits$MessagesPerSecond" : "The maximum number of messages per second that the campaign will send. This is a best effort maximum cap and can go as high as 20000 and as low as 50",
"CampaignLimits$Total" : "The maximum total number of messages that the campaign can send.",
"CampaignResponse$HoldoutPercent" : "The allocated percentage of end users who will not receive messages from this campaign.",
"CampaignResponse$SegmentVersion" : "The version of the segment to which the campaign sends messages.",
"CampaignResponse$Version" : "The campaign version number.",
"EmailChannelResponse$Version" : "Version of channel",
"EndpointMessageResult$StatusCode" : "Downstream service status code.",
"GCMChannelResponse$Version" : "Version of channel",
"GCMMessage$TimeToLive" : "This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks.",
"ImportJobResponse$CompletedPieces" : "The number of pieces that have successfully imported as of the time of the request.",
"ImportJobResponse$FailedPieces" : "The number of pieces that have failed to import as of the time of the request.",
"ImportJobResponse$TotalFailures" : "The number of endpoints that failed to import; for example, because of syntax errors.",
"ImportJobResponse$TotalPieces" : "The total number of pieces that must be imported to finish the job. Each piece is an approximately equal portion of the endpoints to import.",
"ImportJobResponse$TotalProcessed" : "The number of endpoints that were processed by the import job.",
"MessageResult$StatusCode" : "Downstream service status code.",
"SMSChannelResponse$Version" : "Version of channel",
"SegmentImportResource$Size" : "The number of endpoints that were successfully imported to create this segment.",
"SegmentResponse$Version" : "The segment version number.",
"TreatmentResource$SizePercent" : "The allocated percentage of users for this treatment.",
"WriteCampaignRequest$HoldoutPercent" : "The allocated percentage of end users who will not receive messages from this campaign.",
"WriteCampaignRequest$SegmentVersion" : "The version of the segment to which the campaign sends messages.",
"WriteTreatmentResource$SizePercent" : "The allocated percentage of users for this treatment."
}
},
"__string" : {
"base" : null,
"refs" : {
"ADMChannelRequest$ClientId" : "Client ID as gotten from Amazon",
"ADMChannelRequest$ClientSecret" : "Client secret as gotten from Amazon",
"ADMChannelResponse$ApplicationId" : "Application id",
"ADMChannelResponse$CreationDate" : "When was this segment created",
"ADMChannelResponse$Id" : "Channel ID. Not used, only for backwards compatibility.",
"ADMChannelResponse$LastModifiedBy" : "Who last updated this entry",
"ADMChannelResponse$LastModifiedDate" : "Last date this was updated",
"ADMChannelResponse$Platform" : "Platform type. Will be \"ADM\"",
"ADMMessage$Body" : "The message body of the notification, the email body or the text message.",
"ADMMessage$ConsolidationKey" : "Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one.",
"ADMMessage$ExpiresAfter" : "Optional. Number of seconds ADM should retain the message if the device is offline",
"ADMMessage$IconReference" : "The icon image name of the asset saved in your application.",
"ADMMessage$ImageIconUrl" : "The URL that points to an image used as the large icon to the notification content view.",
"ADMMessage$ImageUrl" : "The URL that points to an image used in the push notification.",
"ADMMessage$MD5" : "Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity",
"ADMMessage$RawContent" : "The Raw JSON formatted string to be used as the payload. This value overrides the message.",
"ADMMessage$SmallImageIconUrl" : "The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view",
"ADMMessage$Sound" : "Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/",
"ADMMessage$Title" : "The message title that displays above the message on the user's device.",
"ADMMessage$Url" : "The URL to open in the user's mobile browser. Used if the value for Action is URL.",
"APNSChannelRequest$BundleId" : "The bundle id used for APNs Tokens.",
"APNSChannelRequest$Certificate" : "The distribution certificate from Apple.",
"APNSChannelRequest$DefaultAuthenticationMethod" : "The default authentication method used for APNs.",
"APNSChannelRequest$PrivateKey" : "The certificate private key.",
"APNSChannelRequest$TeamId" : "The team id used for APNs Tokens.",
"APNSChannelRequest$TokenKey" : "The token key used for APNs Tokens.",
"APNSChannelRequest$TokenKeyId" : "The token key used for APNs Tokens.",
"APNSChannelResponse$ApplicationId" : "The ID of the application to which the channel applies.",
"APNSChannelResponse$CreationDate" : "When was this segment created",
"APNSChannelResponse$DefaultAuthenticationMethod" : "The default authentication method used for APNs.",
"APNSChannelResponse$Id" : "Channel ID. Not used. Present only for backwards compatibility.",
"APNSChannelResponse$LastModifiedBy" : "Who last updated this entry",
"APNSChannelResponse$LastModifiedDate" : "Last date this was updated",
"APNSChannelResponse$Platform" : "The platform type. Will be APNS.",
"APNSMessage$Body" : "The message body of the notification, the email body or the text message.",
"APNSMessage$Category" : "Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.",
"APNSMessage$CollapseId" : "Multiple notifications with the same collapse identifier are displayed to the user as a single notification. The value of this key must not exceed 64 bytes.",
"APNSMessage$MediaUrl" : "The URL that points to a video used in the push notification.",
"APNSMessage$PreferredAuthenticationMethod" : "The preferred authentication method, either \"CERTIFICATE\" or \"TOKEN\"",
"APNSMessage$Priority" : "Is this a transaction priority message or lower priority.",
"APNSMessage$RawContent" : "The Raw JSON formatted string to be used as the payload. This value overrides the message.",
"APNSMessage$Sound" : "Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.",
"APNSMessage$ThreadId" : "Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.",
"APNSMessage$Title" : "The message title that displays above the message on the user's device.",
"APNSMessage$Url" : "The URL to open in the user's mobile browser. Used if the value for Action is URL.",
"APNSSandboxChannelRequest$BundleId" : "The bundle id used for APNs Tokens.",
"APNSSandboxChannelRequest$Certificate" : "The distribution certificate from Apple.",
"APNSSandboxChannelRequest$DefaultAuthenticationMethod" : "The default authentication method used for APNs.",
"APNSSandboxChannelRequest$PrivateKey" : "The certificate private key.",
"APNSSandboxChannelRequest$TeamId" : "The team id used for APNs Tokens.",
"APNSSandboxChannelRequest$TokenKey" : "The token key used for APNs Tokens.",
"APNSSandboxChannelRequest$TokenKeyId" : "The token key used for APNs Tokens.",
"APNSSandboxChannelResponse$ApplicationId" : "Application id",
"APNSSandboxChannelResponse$CreationDate" : "When was this segment created",
"APNSSandboxChannelResponse$DefaultAuthenticationMethod" : "The default authentication method used for APNs.",
"APNSSandboxChannelResponse$Id" : "Channel ID. Not used, only for backwards compatibility.",
"APNSSandboxChannelResponse$LastModifiedBy" : "Who last updated this entry",
"APNSSandboxChannelResponse$LastModifiedDate" : "Last date this was updated",
"APNSSandboxChannelResponse$Platform" : "The platform type. Will be APNS_SANDBOX.",
"APNSVoipChannelRequest$BundleId" : "The bundle id used for APNs Tokens.",
"APNSVoipChannelRequest$Certificate" : "The distribution certificate from Apple.",
"APNSVoipChannelRequest$DefaultAuthenticationMethod" : "The default authentication method used for APNs.",
"APNSVoipChannelRequest$PrivateKey" : "The certificate private key.",
"APNSVoipChannelRequest$TeamId" : "The team id used for APNs Tokens.",
"APNSVoipChannelRequest$TokenKey" : "The token key used for APNs Tokens.",
"APNSVoipChannelRequest$TokenKeyId" : "The token key used for APNs Tokens.",
"APNSVoipChannelResponse$ApplicationId" : "Application id",
"APNSVoipChannelResponse$CreationDate" : "When was this segment created",
"APNSVoipChannelResponse$DefaultAuthenticationMethod" : "The default authentication method used for APNs.",
"APNSVoipChannelResponse$Id" : "Channel ID. Not used, only for backwards compatibility.",
"APNSVoipChannelResponse$LastModifiedBy" : "Who made the last change",
"APNSVoipChannelResponse$LastModifiedDate" : "Last date this was updated",
"APNSVoipChannelResponse$Platform" : "The platform type. Will be APNS.",
"APNSVoipSandboxChannelRequest$BundleId" : "The bundle id used for APNs Tokens.",
"APNSVoipSandboxChannelRequest$Certificate" : "The distribution certificate from Apple.",
"APNSVoipSandboxChannelRequest$DefaultAuthenticationMethod" : "The default authentication method used for APNs.",
"APNSVoipSandboxChannelRequest$PrivateKey" : "The certificate private key.",
"APNSVoipSandboxChannelRequest$TeamId" : "The team id used for APNs Tokens.",
"APNSVoipSandboxChannelRequest$TokenKey" : "The token key used for APNs Tokens.",
"APNSVoipSandboxChannelRequest$TokenKeyId" : "The token key used for APNs Tokens.",
"APNSVoipSandboxChannelResponse$ApplicationId" : "Application id",
"APNSVoipSandboxChannelResponse$CreationDate" : "When was this segment created",
"APNSVoipSandboxChannelResponse$DefaultAuthenticationMethod" : "The default authentication method used for APNs.",
"APNSVoipSandboxChannelResponse$Id" : "Channel ID. Not used, only for backwards compatibility.",
"APNSVoipSandboxChannelResponse$LastModifiedBy" : "Who made the last change",
"APNSVoipSandboxChannelResponse$LastModifiedDate" : "Last date this was updated",
"APNSVoipSandboxChannelResponse$Platform" : "The platform type. Will be APNS.",
"ActivityResponse$ApplicationId" : "The ID of the application to which the campaign applies.",
"ActivityResponse$CampaignId" : "The ID of the campaign to which the activity applies.",
"ActivityResponse$End" : "The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.",
"ActivityResponse$Id" : "The unique activity ID.",
"ActivityResponse$Result" : "Indicates whether the activity succeeded.\n\nValid values: SUCCESS, FAIL",
"ActivityResponse$ScheduledStart" : "The scheduled start time for the activity in ISO 8601 format.",
"ActivityResponse$Start" : "The actual start time of the activity in ISO 8601 format.",
"ActivityResponse$State" : "The state of the activity.\n\nValid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED",
"ActivityResponse$TreatmentId" : "The ID of a variation of the campaign used for A/B testing.",
"AddressConfiguration$BodyOverride" : "Body override. If specified will override default body.",
"AddressConfiguration$RawContent" : "The Raw JSON formatted string to be used as the payload. This value overrides the message.",
"AddressConfiguration$TitleOverride" : "Title override. If specified will override default title if applicable.",
"ApplicationResponse$Id" : "The unique application ID.",
"ApplicationResponse$Name" : "The display name of the application.",
"ApplicationSettingsResource$ApplicationId" : "The unique ID for the application.",
"ApplicationSettingsResource$LastModifiedDate" : "The date that the settings were last updated in ISO 8601 format.",
"ApplicationsResponse$NextToken" : "The string that you use in a subsequent request to get the next page of results in a paginated response.",
"BaiduChannelRequest$ApiKey" : "Platform credential API key from Baidu.",
"BaiduChannelRequest$SecretKey" : "Platform credential Secret key from Baidu.",
"BaiduChannelResponse$ApplicationId" : "Application id",
"BaiduChannelResponse$CreationDate" : "When was this segment created",
"BaiduChannelResponse$Credential" : "The Baidu API key from Baidu.",
"BaiduChannelResponse$Id" : "Channel ID. Not used, only for backwards compatibility.",
"BaiduChannelResponse$LastModifiedBy" : "Who made the last change",
"BaiduChannelResponse$LastModifiedDate" : "Last date this was updated",
"BaiduChannelResponse$Platform" : "The platform type. Will be BAIDU",
"BaiduMessage$Body" : "The message body of the notification, the email body or the text message.",
"BaiduMessage$IconReference" : "The icon image name of the asset saved in your application.",
"BaiduMessage$ImageIconUrl" : "The URL that points to an image used as the large icon to the notification content view.",
"BaiduMessage$ImageUrl" : "The URL that points to an image used in the push notification.",
"BaiduMessage$RawContent" : "The Raw JSON formatted string to be used as the payload. This value overrides the message.",
"BaiduMessage$SmallImageIconUrl" : "The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view",
"BaiduMessage$Sound" : "Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/",
"BaiduMessage$Title" : "The message title that displays above the message on the user's device.",
"BaiduMessage$Url" : "The URL to open in the user's mobile browser. Used if the value for Action is URL.",
"CampaignEmailMessage$Body" : "The email text body.",
"CampaignEmailMessage$FromAddress" : "The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.",
"CampaignEmailMessage$HtmlBody" : "The email html body.",
"CampaignEmailMessage$Title" : "The email title (Or subject).",
"CampaignResponse$ApplicationId" : "The ID of the application to which the campaign applies.",
"CampaignResponse$CreationDate" : "The date the campaign was created in ISO 8601 format.",
"CampaignResponse$Description" : "A description of the campaign.",
"CampaignResponse$Id" : "The unique campaign ID.",
"CampaignResponse$LastModifiedDate" : "The date the campaign was last updated in ISO 8601 format.\t",
"CampaignResponse$Name" : "The custom name of the campaign.",
"CampaignResponse$SegmentId" : "The ID of the segment to which the campaign sends messages.",
"CampaignResponse$TreatmentDescription" : "A custom description for the treatment.",
"CampaignResponse$TreatmentName" : "The custom name of a variation of the campaign used for A/B testing.",
"CampaignSmsMessage$Body" : "The SMS text body.",
"CampaignSmsMessage$SenderId" : "Sender ID of sent message.",
"CampaignsResponse$NextToken" : "The string that you use in a subsequent request to get the next page of results in a paginated response.",
"CreateApplicationRequest$Name" : "The display name of the application. Used in the Amazon Pinpoint console.",
"DefaultMessage$Body" : "The message body of the notification, the email body or the text message.",
"DefaultPushNotificationMessage$Body" : "The message body of the notification, the email body or the text message.",
"DefaultPushNotificationMessage$Title" : "The message title that displays above the message on the user's device.",
"DefaultPushNotificationMessage$Url" : "The URL to open in the user's mobile browser. Used if the value for Action is URL.",
"EmailChannelRequest$FromAddress" : "The email address used to send emails from.",
"EmailChannelRequest$Identity" : "The ARN of an identity verified with SES.",
"EmailChannelRequest$RoleArn" : "The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service",
"EmailChannelResponse$ApplicationId" : "The unique ID of the application to which the email channel belongs.",
"EmailChannelResponse$CreationDate" : "The date that the settings were last updated in ISO 8601 format.",
"EmailChannelResponse$FromAddress" : "The email address used to send emails from.",
"EmailChannelResponse$Id" : "Channel ID. Not used, only for backwards compatibility.",
"EmailChannelResponse$Identity" : "The ARN of an identity verified with SES.",
"EmailChannelResponse$LastModifiedBy" : "Who last updated this entry",
"EmailChannelResponse$LastModifiedDate" : "Last date this was updated",
"EmailChannelResponse$Platform" : "Platform type. Will be \"EMAIL\"",
"EmailChannelResponse$RoleArn" : "The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service",
"EndpointBatchItem$Address" : "The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).",
"EndpointBatchItem$EffectiveDate" : "The last time the endpoint was updated. Provided in ISO 8601 format.",
"EndpointBatchItem$EndpointStatus" : "The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.",
"EndpointBatchItem$Id" : "The unique Id for the Endpoint in the batch.",
"EndpointBatchItem$OptOut" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL - User has opted out of all messages.\n\nNONE - Users has not opted out and receives all messages.",
"EndpointBatchItem$RequestId" : "The unique ID for the most recent request to update the endpoint.",
"EndpointDemographic$AppVersion" : "The version of the application associated with the endpoint.",
"EndpointDemographic$Locale" : "The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.\n",
"EndpointDemographic$Make" : "The endpoint make, such as such as Apple or Samsung.",
"EndpointDemographic$Model" : "The endpoint model, such as iPhone.",
"EndpointDemographic$ModelVersion" : "The endpoint model version.",
"EndpointDemographic$Platform" : "The endpoint platform, such as ios or android.",
"EndpointDemographic$PlatformVersion" : "The endpoint platform version.",
"EndpointDemographic$Timezone" : "The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.",
"EndpointLocation$City" : "The city where the endpoint is located.",
"EndpointLocation$Country" : "Country according to ISO 3166-1 Alpha-2 codes. For example, US.",
"EndpointLocation$PostalCode" : "The postal code or zip code of the endpoint.",
"EndpointLocation$Region" : "The region of the endpoint location. For example, corresponds to a state in US.",
"EndpointMessageResult$Address" : "Address that endpoint message was delivered to.",
"EndpointMessageResult$StatusMessage" : "Status message for message delivery.",
"EndpointMessageResult$UpdatedToken" : "If token was updated as part of delivery. (This is GCM Specific)",
"EndpointRequest$Address" : "The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).",
"EndpointRequest$EffectiveDate" : "The last time the endpoint was updated. Provided in ISO 8601 format.",
"EndpointRequest$EndpointStatus" : "The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.",
"EndpointRequest$OptOut" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL - User has opted out of all messages.\n\nNONE - Users has not opted out and receives all messages.",
"EndpointRequest$RequestId" : "The unique ID for the most recent request to update the endpoint.",
"EndpointResponse$Address" : "The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).",
"EndpointResponse$ApplicationId" : "The ID of the application associated with the endpoint.",
"EndpointResponse$CohortId" : "A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.",
"EndpointResponse$CreationDate" : "The last time the endpoint was created. Provided in ISO 8601 format.",
"EndpointResponse$EffectiveDate" : "The last time the endpoint was updated. Provided in ISO 8601 format.",
"EndpointResponse$EndpointStatus" : "The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.",
"EndpointResponse$Id" : "The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.",
"EndpointResponse$OptOut" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL - User has opted out of all messages.\n\nNONE - Users has not opted out and receives all messages.",
"EndpointResponse$RequestId" : "The unique ID for the most recent request to update the endpoint.",
"EndpointSendConfiguration$BodyOverride" : "Body override. If specified will override default body.",
"EndpointSendConfiguration$RawContent" : "The Raw JSON formatted string to be used as the payload. This value overrides the message.",
"EndpointSendConfiguration$TitleOverride" : "Title override. If specified will override default title if applicable.",
"EndpointUser$UserId" : "The unique ID of the user.",
"EventStream$ApplicationId" : "The ID of the application from which events should be published.",
"EventStream$DestinationStreamArn" : "The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events.\n Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME\n Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME",
"EventStream$ExternalId" : "The external ID assigned the IAM role that authorizes Amazon Pinpoint to publish to the stream.",
"EventStream$LastModifiedDate" : "The date the event stream was last updated in ISO 8601 format.",
"EventStream$LastUpdatedBy" : "The IAM user who last modified the event stream.",
"EventStream$RoleArn" : "The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.",
"GCMChannelRequest$ApiKey" : "Platform credential API key from Google.",
"GCMChannelResponse$ApplicationId" : "The ID of the application to which the channel applies.",
"GCMChannelResponse$CreationDate" : "When was this segment created",
"GCMChannelResponse$Credential" : "The GCM API key from Google.",
"GCMChannelResponse$Id" : "Channel ID. Not used. Present only for backwards compatibility.",
"GCMChannelResponse$LastModifiedBy" : "Who last updated this entry",
"GCMChannelResponse$LastModifiedDate" : "Last date this was updated",
"GCMChannelResponse$Platform" : "The platform type. Will be GCM",
"GCMMessage$Body" : "The message body of the notification, the email body or the text message.",
"GCMMessage$CollapseKey" : "This parameter identifies a group of messages (e.g., with collapse_key: \"Updates Available\") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.",
"GCMMessage$IconReference" : "The icon image name of the asset saved in your application.",
"GCMMessage$ImageIconUrl" : "The URL that points to an image used as the large icon to the notification content view.",
"GCMMessage$ImageUrl" : "The URL that points to an image used in the push notification.",
"GCMMessage$Priority" : "Is this a transaction priority message or lower priority.",
"GCMMessage$RawContent" : "The Raw JSON formatted string to be used as the payload. This value overrides the message.",
"GCMMessage$RestrictedPackageName" : "This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.",
"GCMMessage$SmallImageIconUrl" : "The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view",
"GCMMessage$Sound" : "Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/",
"GCMMessage$Title" : "The message title that displays above the message on the user's device.",
"GCMMessage$Url" : "The URL to open in the user's mobile browser. Used if the value for Action is URL.",
"ImportJobRequest$ExternalId" : "A unique, custom ID assigned to the IAM role that restricts who can assume the role.\t",
"ImportJobRequest$RoleArn" : "The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.",
"ImportJobRequest$S3Url" : "A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file.\nThe URL should follow this format: s3://bucket-name/folder-name/file-name\n\nAmazon Pinpoint will import endpoints from this location and any subfolders it contains.",
"ImportJobRequest$SegmentId" : "The ID of the segment to update if the import job is meant to update an existing segment.",
"ImportJobRequest$SegmentName" : "A custom name for the segment created by the import job. Use if DefineSegment is true.",
"ImportJobResource$ExternalId" : "A unique, custom ID assigned to the IAM role that restricts who can assume the role.\t",
"ImportJobResource$RoleArn" : "The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.",
"ImportJobResource$S3Url" : "A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file.\nThe URL should follow this format: s3://bucket-name/folder-name/file-name\n\nAmazon Pinpoint will import endpoints from this location and any subfolders it contains.",
"ImportJobResource$SegmentId" : "The ID of the segment to update if the import job is meant to update an existing segment.",
"ImportJobResource$SegmentName" : "A custom name for the segment created by the import job. Use if DefineSegment is true.",
"ImportJobResponse$ApplicationId" : "The unique ID of the application to which the import job applies.",
"ImportJobResponse$CompletionDate" : "The date the import job completed in ISO 8601 format.",
"ImportJobResponse$CreationDate" : "The date the import job was created in ISO 8601 format.",
"ImportJobResponse$Id" : "The unique ID of the import job.",
"ImportJobResponse$Type" : "The job type. Will be Import.",
"ImportJobsResponse$NextToken" : "The string that you use in a subsequent request to get the next page of results in a paginated response.",
"Message$Body" : "The message body. Can include up to 140 characters.",
"Message$ImageIconUrl" : "The URL that points to the icon image for the push notification icon, for example, the app icon.",
"Message$ImageSmallIconUrl" : "The URL that points to the small icon image for the push notification icon, for example, the app icon.",
"Message$ImageUrl" : "The URL that points to an image used in the push notification.",
"Message$JsonBody" : "The JSON payload used for a silent push.",
"Message$MediaUrl" : "The URL that points to the media resource, for example a .mp4 or .gif file.",
"Message$RawContent" : "The Raw JSON formatted string to be used as the payload. This value overrides the message.",
"Message$Title" : "The message title that displays above the message on the user's device.",
"Message$Url" : "The URL to open in the user's mobile browser. Used if the value for Action is URL.",
"MessageBody$Message" : "The error message returned from the API.",
"MessageBody$RequestID" : "The unique message body ID.",
"MessageResponse$ApplicationId" : "Application id of the message.",
"MessageResponse$RequestId" : "Original request Id for which this message was delivered.",
"MessageResult$StatusMessage" : "Status message for message delivery.",
"MessageResult$UpdatedToken" : "If token was updated as part of delivery. (This is GCM Specific)",
"QuietTime$End" : "The default end time for quiet time in ISO 8601 format.",
"QuietTime$Start" : "The default start time for quiet time in ISO 8601 format.",
"SMSChannelRequest$SenderId" : "Sender identifier of your messages.",
"SMSChannelRequest$ShortCode" : "ShortCode registered with phone provider.",
"SMSChannelResponse$ApplicationId" : "The unique ID of the application to which the SMS channel belongs.",
"SMSChannelResponse$CreationDate" : "The date that the settings were last updated in ISO 8601 format.",
"SMSChannelResponse$Id" : "Channel ID. Not used, only for backwards compatibility.",
"SMSChannelResponse$LastModifiedBy" : "Who last updated this entry",
"SMSChannelResponse$LastModifiedDate" : "Last date this was updated",
"SMSChannelResponse$Platform" : "Platform type. Will be \"SMS\"",
"SMSChannelResponse$SenderId" : "Sender identifier of your messages.",
"SMSChannelResponse$ShortCode" : "The short code registered with the phone provider.",
"SMSMessage$Body" : "The message body of the notification, the email body or the text message.",
"SMSMessage$SenderId" : "Sender ID of sent message.",
"Schedule$EndTime" : "The scheduled time that the campaign ends in ISO 8601 format.",
"Schedule$StartTime" : "The scheduled time that the campaign begins in ISO 8601 format.",
"Schedule$Timezone" : "The starting UTC offset for the schedule if the value for isLocalTime is true\n\nValid values: \nUTC\nUTC+01\nUTC+02\nUTC+03\nUTC+03:30\nUTC+04\nUTC+04:30\nUTC+05\nUTC+05:30\nUTC+05:45\nUTC+06\nUTC+06:30\nUTC+07\nUTC+08\nUTC+09\nUTC+09:30\nUTC+10\nUTC+10:30\nUTC+11\nUTC+12\nUTC+13\nUTC-02\nUTC-03\nUTC-04\nUTC-05\nUTC-06\nUTC-07\nUTC-08\nUTC-09\nUTC-10\nUTC-11",
"SegmentImportResource$ExternalId" : "A unique, custom ID assigned to the IAM role that restricts who can assume the role.",
"SegmentImportResource$RoleArn" : "The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.",
"SegmentImportResource$S3Url" : "A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.",
"SegmentResponse$ApplicationId" : "The ID of the application to which the segment applies.",
"SegmentResponse$CreationDate" : "The date the segment was created in ISO 8601 format.",
"SegmentResponse$Id" : "The unique segment ID.",
"SegmentResponse$LastModifiedDate" : "The date the segment was last updated in ISO 8601 format.",
"SegmentResponse$Name" : "The name of segment",
"SegmentsResponse$NextToken" : "An identifier used to retrieve the next page of results. The token is null if no additional pages exist.",
"SendUsersMessageResponse$ApplicationId" : "Application id of the message.",
"SendUsersMessageResponse$RequestId" : "Original request Id for which this message was delivered.",
"TreatmentResource$Id" : "The unique treatment ID.",
"TreatmentResource$TreatmentDescription" : "A custom description for the treatment.",
"TreatmentResource$TreatmentName" : "The custom name of a variation of the campaign used for A/B testing.",
"WriteCampaignRequest$Description" : "A description of the campaign.",
"WriteCampaignRequest$Name" : "The custom name of the campaign.",
"WriteCampaignRequest$SegmentId" : "The ID of the segment to which the campaign sends messages.",
"WriteCampaignRequest$TreatmentDescription" : "A custom description for the treatment.",
"WriteCampaignRequest$TreatmentName" : "The custom name of a variation of the campaign used for A/B testing.",
"WriteEventStream$DestinationStreamArn" : "The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events.\n Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME\n Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME",
"WriteEventStream$RoleArn" : "The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.",
"WriteSegmentRequest$Name" : "The name of segment",
"WriteTreatmentResource$TreatmentDescription" : "A custom description for the treatment.",
"WriteTreatmentResource$TreatmentName" : "The custom name of a variation of the campaign used for A/B testing.",
"PutEventStreamRequest$ApplicationId": "Application Id.",
"PutEventStreamRequest$WriteEventStream": "Write event stream wrapper.",
"GetEventStreamRequest$ApplicationId": "Application Id.",
"DeleteEventStreamRequest$ApplicationId": "Application Id."
}
}
}
}