aws-sdk

{ "metadata": { "apiVersion": "2016-12-01", "endpointPrefix": "pinpoint", "signingName": "mobiletargeting", "serviceFullName": "Amazon Pinpoint", "serviceId": "Pinpoint", "protocol": "rest-json", "jsonVersion": "1.1", "uid": "pinpoint-2016-12-01", "signatureVersion": "v4", "auth": [ "aws.auth#sigv4" ] }, "operations": { "CreateApp": { "http": { "requestUri": "/v1/apps", "responseCode": 201 }, "input": { "type": "structure", "members": { "CreateApplicationRequest": { "type": "structure", "members": { "Name": {}, "tags": { "shape": "S4", "locationName": "tags" } }, "required": [ "Name" ] } }, "required": [ "CreateApplicationRequest" ], "payload": "CreateApplicationRequest" }, "output": { "type": "structure", "members": { "ApplicationResponse": { "shape": "S6" } }, "required": [ "ApplicationResponse" ], "payload": "ApplicationResponse" } }, "CreateCampaign": { "http": { "requestUri": "/v1/apps/{application-id}/campaigns", "responseCode": 201 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "WriteCampaignRequest": { "shape": "S8" } }, "required": [ "ApplicationId", "WriteCampaignRequest" ], "payload": "WriteCampaignRequest" }, "output": { "type": "structure", "members": { "CampaignResponse": { "shape": "S1l" } }, "required": [ "CampaignResponse" ], "payload": "CampaignResponse" } }, "CreateEmailTemplate": { "http": { "requestUri": "/v1/templates/{template-name}/email", "responseCode": 201 }, "input": { "type": "structure", "members": { "EmailTemplateRequest": { "shape": "S1r" }, "TemplateName": { "location": "uri", "locationName": "template-name" } }, "required": [ "TemplateName", "EmailTemplateRequest" ], "payload": "EmailTemplateRequest" }, "output": { "type": "structure", "members": { "CreateTemplateMessageBody": { "shape": "S1t" } }, "required": [ "CreateTemplateMessageBody" ], "payload": "CreateTemplateMessageBody" } }, "CreateExportJob": { "http": { "requestUri": "/v1/apps/{application-id}/jobs/export", "responseCode": 202 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "ExportJobRequest": { "type": "structure", "members": { "RoleArn": {}, "S3UrlPrefix": {}, "SegmentId": {}, "SegmentVersion": { "type": "integer" } }, "required": [ "S3UrlPrefix", "RoleArn" ] } }, "required": [ "ApplicationId", "ExportJobRequest" ], "payload": "ExportJobRequest" }, "output": { "type": "structure", "members": { "ExportJobResponse": { "shape": "S1x" } }, "required": [ "ExportJobResponse" ], "payload": "ExportJobResponse" } }, "CreateImportJob": { "http": { "requestUri": "/v1/apps/{application-id}/jobs/import", "responseCode": 201 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "ImportJobRequest": { "type": "structure", "members": { "DefineSegment": { "type": "boolean" }, "ExternalId": {}, "Format": {}, "RegisterEndpoints": { "type": "boolean" }, "RoleArn": {}, "S3Url": {}, "SegmentId": {}, "SegmentName": {} }, "required": [ "Format", "S3Url", "RoleArn" ] } }, "required": [ "ApplicationId", "ImportJobRequest" ], "payload": "ImportJobRequest" }, "output": { "type": "structure", "members": { "ImportJobResponse": { "shape": "S24" } }, "required": [ "ImportJobResponse" ], "payload": "ImportJobResponse" } }, "CreateInAppTemplate": { "http": { "requestUri": "/v1/templates/{template-name}/inapp", "responseCode": 201 }, "input": { "type": "structure", "members": { "InAppTemplateRequest": { "shape": "S27" }, "TemplateName": { "location": "uri", "locationName": "template-name" } }, "required": [ "TemplateName", "InAppTemplateRequest" ], "payload": "InAppTemplateRequest" }, "output": { "type": "structure", "members": { "TemplateCreateMessageBody": { "type": "structure", "members": { "Arn": {}, "Message": {}, "RequestID": {} } } }, "required": [ "TemplateCreateMessageBody" ], "payload": "TemplateCreateMessageBody" } }, "CreateJourney": { "http": { "requestUri": "/v1/apps/{application-id}/journeys", "responseCode": 201 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "WriteJourneyRequest": { "shape": "S2b" } }, "required": [ "ApplicationId", "WriteJourneyRequest" ], "payload": "WriteJourneyRequest" }, "output": { "type": "structure", "members": { "JourneyResponse": { "shape": "S3w" } }, "required": [ "JourneyResponse" ], "payload": "JourneyResponse" } }, "CreatePushTemplate": { "http": { "requestUri": "/v1/templates/{template-name}/push", "responseCode": 201 }, "input": { "type": "structure", "members": { "PushNotificationTemplateRequest": { "shape": "S3y" }, "TemplateName": { "location": "uri", "locationName": "template-name" } }, "required": [ "TemplateName", "PushNotificationTemplateRequest" ], "payload": "PushNotificationTemplateRequest" }, "output": { "type": "structure", "members": { "CreateTemplateMessageBody": { "shape": "S1t" } }, "required": [ "CreateTemplateMessageBody" ], "payload": "CreateTemplateMessageBody" } }, "CreateRecommenderConfiguration": { "http": { "requestUri": "/v1/recommenders", "responseCode": 201 }, "input": { "type": "structure", "members": { "CreateRecommenderConfiguration": { "type": "structure", "members": { "Attributes": { "shape": "S4" }, "Description": {}, "Name": {}, "RecommendationProviderIdType": {}, "RecommendationProviderRoleArn": {}, "RecommendationProviderUri": {}, "RecommendationTransformerUri": {}, "RecommendationsDisplayName": {}, "RecommendationsPerMessage": { "type": "integer" } }, "required": [ "RecommendationProviderUri", "RecommendationProviderRoleArn" ] } }, "required": [ "CreateRecommenderConfiguration" ], "payload": "CreateRecommenderConfiguration" }, "output": { "type": "structure", "members": { "RecommenderConfigurationResponse": { "shape": "S46" } }, "required": [ "RecommenderConfigurationResponse" ], "payload": "RecommenderConfigurationResponse" } }, "CreateSegment": { "http": { "requestUri": "/v1/apps/{application-id}/segments", "responseCode": 201 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "WriteSegmentRequest": { "shape": "S48" } }, "required": [ "ApplicationId", "WriteSegmentRequest" ], "payload": "WriteSegmentRequest" }, "output": { "type": "structure", "members": { "SegmentResponse": { "shape": "S4j" } }, "required": [ "SegmentResponse" ], "payload": "SegmentResponse" } }, "CreateSmsTemplate": { "http": { "requestUri": "/v1/templates/{template-name}/sms", "responseCode": 201 }, "input": { "type": "structure", "members": { "SMSTemplateRequest": { "shape": "S4o" }, "TemplateName": { "location": "uri", "locationName": "template-name" } }, "required": [ "TemplateName", "SMSTemplateRequest" ], "payload": "SMSTemplateRequest" }, "output": { "type": "structure", "members": { "CreateTemplateMessageBody": { "shape": "S1t" } }, "required": [ "CreateTemplateMessageBody" ], "payload": "CreateTemplateMessageBody" } }, "CreateVoiceTemplate": { "http": { "requestUri": "/v1/templates/{template-name}/voice", "responseCode": 201 }, "input": { "type": "structure", "members": { "TemplateName": { "location": "uri", "locationName": "template-name" }, "VoiceTemplateRequest": { "shape": "S4r" } }, "required": [ "TemplateName", "VoiceTemplateRequest" ], "payload": "VoiceTemplateRequest" }, "output": { "type": "structure", "members": { "CreateTemplateMessageBody": { "shape": "S1t" } }, "required": [ "CreateTemplateMessageBody" ], "payload": "CreateTemplateMessageBody" } }, "DeleteAdmChannel": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/channels/adm", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "ADMChannelResponse": { "shape": "S4v" } }, "required": [ "ADMChannelResponse" ], "payload": "ADMChannelResponse" } }, "DeleteApnsChannel": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/channels/apns", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "APNSChannelResponse": { "shape": "S4y" } }, "required": [ "APNSChannelResponse" ], "payload": "APNSChannelResponse" } }, "DeleteApnsSandboxChannel": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/channels/apns_sandbox", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "APNSSandboxChannelResponse": { "shape": "S51" } }, "required": [ "APNSSandboxChannelResponse" ], "payload": "APNSSandboxChannelResponse" } }, "DeleteApnsVoipChannel": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/channels/apns_voip", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "APNSVoipChannelResponse": { "shape": "S54" } }, "required": [ "APNSVoipChannelResponse" ], "payload": "APNSVoipChannelResponse" } }, "DeleteApnsVoipSandboxChannel": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/channels/apns_voip_sandbox", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "APNSVoipSandboxChannelResponse": { "shape": "S57" } }, "required": [ "APNSVoipSandboxChannelResponse" ], "payload": "APNSVoipSandboxChannelResponse" } }, "DeleteApp": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "ApplicationResponse": { "shape": "S6" } }, "required": [ "ApplicationResponse" ], "payload": "ApplicationResponse" } }, "DeleteBaiduChannel": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/channels/baidu", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "BaiduChannelResponse": { "shape": "S5c" } }, "required": [ "BaiduChannelResponse" ], "payload": "BaiduChannelResponse" } }, "DeleteCampaign": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "CampaignId": { "location": "uri", "locationName": "campaign-id" } }, "required": [ "CampaignId", "ApplicationId" ] }, "output": { "type": "structure", "members": { "CampaignResponse": { "shape": "S1l" } }, "required": [ "CampaignResponse" ], "payload": "CampaignResponse" } }, "DeleteEmailChannel": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/channels/email", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "EmailChannelResponse": { "shape": "S5h" } }, "required": [ "EmailChannelResponse" ], "payload": "EmailChannelResponse" } }, "DeleteEmailTemplate": { "http": { "method": "DELETE", "requestUri": "/v1/templates/{template-name}/email", "responseCode": 202 }, "input": { "type": "structure", "members": { "TemplateName": { "location": "uri", "locationName": "template-name" }, "Version": { "location": "querystring", "locationName": "version" } }, "required": [ "TemplateName" ] }, "output": { "type": "structure", "members": { "MessageBody": { "shape": "S5k" } }, "required": [ "MessageBody" ], "payload": "MessageBody" } }, "DeleteEndpoint": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/endpoints/{endpoint-id}", "responseCode": 202 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "EndpointId": { "location": "uri", "locationName": "endpoint-id" } }, "required": [ "ApplicationId", "EndpointId" ] }, "output": { "type": "structure", "members": { "EndpointResponse": { "shape": "S5n" } }, "required": [ "EndpointResponse" ], "payload": "EndpointResponse" } }, "DeleteEventStream": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/eventstream", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "EventStream": { "shape": "S5w" } }, "required": [ "EventStream" ], "payload": "EventStream" } }, "DeleteGcmChannel": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/channels/gcm", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "GCMChannelResponse": { "shape": "S5z" } }, "required": [ "GCMChannelResponse" ], "payload": "GCMChannelResponse" } }, "DeleteInAppTemplate": { "http": { "method": "DELETE", "requestUri": "/v1/templates/{template-name}/inapp", "responseCode": 202 }, "input": { "type": "structure", "members": { "TemplateName": { "location": "uri", "locationName": "template-name" }, "Version": { "location": "querystring", "locationName": "version" } }, "required": [ "TemplateName" ] }, "output": { "type": "structure", "members": { "MessageBody": { "shape": "S5k" } }, "required": [ "MessageBody" ], "payload": "MessageBody" } }, "DeleteJourney": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/journeys/{journey-id}", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "JourneyId": { "location": "uri", "locationName": "journey-id" } }, "required": [ "JourneyId", "ApplicationId" ] }, "output": { "type": "structure", "members": { "JourneyResponse": { "shape": "S3w" } }, "required": [ "JourneyResponse" ], "payload": "JourneyResponse" } }, "DeletePushTemplate": { "http": { "method": "DELETE", "requestUri": "/v1/templates/{template-name}/push", "responseCode": 202 }, "input": { "type": "structure", "members": { "TemplateName": { "location": "uri", "locationName": "template-name" }, "Version": { "location": "querystring", "locationName": "version" } }, "required": [ "TemplateName" ] }, "output": { "type": "structure", "members": { "MessageBody": { "shape": "S5k" } }, "required": [ "MessageBody" ], "payload": "MessageBody" } }, "DeleteRecommenderConfiguration": { "http": { "method": "DELETE", "requestUri": "/v1/recommenders/{recommender-id}", "responseCode": 200 }, "input": { "type": "structure", "members": { "RecommenderId": { "location": "uri", "locationName": "recommender-id" } }, "required": [ "RecommenderId" ] }, "output": { "type": "structure", "members": { "RecommenderConfigurationResponse": { "shape": "S46" } }, "required": [ "RecommenderConfigurationResponse" ], "payload": "RecommenderConfigurationResponse" } }, "DeleteSegment": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/segments/{segment-id}", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "SegmentId": { "location": "uri", "locationName": "segment-id" } }, "required": [ "SegmentId", "ApplicationId" ] }, "output": { "type": "structure", "members": { "SegmentResponse": { "shape": "S4j" } }, "required": [ "SegmentResponse" ], "payload": "SegmentResponse" } }, "DeleteSmsChannel": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/channels/sms", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "SMSChannelResponse": { "shape": "S6c" } }, "required": [ "SMSChannelResponse" ], "payload": "SMSChannelResponse" } }, "DeleteSmsTemplate": { "http": { "method": "DELETE", "requestUri": "/v1/templates/{template-name}/sms", "responseCode": 202 }, "input": { "type": "structure", "members": { "TemplateName": { "location": "uri", "locationName": "template-name" }, "Version": { "location": "querystring", "locationName": "version" } }, "required": [ "TemplateName" ] }, "output": { "type": "structure", "members": { "MessageBody": { "shape": "S5k" } }, "required": [ "MessageBody" ], "payload": "MessageBody" } }, "DeleteUserEndpoints": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/users/{user-id}", "responseCode": 202 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "UserId": { "location": "uri", "locationName": "user-id" } }, "required": [ "ApplicationId", "UserId" ] }, "output": { "type": "structure", "members": { "EndpointsResponse": { "shape": "S6h" } }, "required": [ "EndpointsResponse" ], "payload": "EndpointsResponse" } }, "DeleteVoiceChannel": { "http": { "method": "DELETE", "requestUri": "/v1/apps/{application-id}/channels/voice", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "VoiceChannelResponse": { "shape": "S6l" } }, "required": [ "VoiceChannelResponse" ], "payload": "VoiceChannelResponse" } }, "DeleteVoiceTemplate": { "http": { "method": "DELETE", "requestUri": "/v1/templates/{template-name}/voice", "responseCode": 202 }, "input": { "type": "structure", "members": { "TemplateName": { "location": "uri", "locationName": "template-name" }, "Version": { "location": "querystring", "locationName": "version" } }, "required": [ "TemplateName" ] }, "output": { "type": "structure", "members": { "MessageBody": { "shape": "S5k" } }, "required": [ "MessageBody" ], "payload": "MessageBody" } }, "GetAdmChannel": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/channels/adm", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "ADMChannelResponse": { "shape": "S4v" } }, "required": [ "ADMChannelResponse" ], "payload": "ADMChannelResponse" } }, "GetApnsChannel": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/channels/apns", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "APNSChannelResponse": { "shape": "S4y" } }, "required": [ "APNSChannelResponse" ], "payload": "APNSChannelResponse" } }, "GetApnsSandboxChannel": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/channels/apns_sandbox", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "APNSSandboxChannelResponse": { "shape": "S51" } }, "required": [ "APNSSandboxChannelResponse" ], "payload": "APNSSandboxChannelResponse" } }, "GetApnsVoipChannel": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/channels/apns_voip", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "APNSVoipChannelResponse": { "shape": "S54" } }, "required": [ "APNSVoipChannelResponse" ], "payload": "APNSVoipChannelResponse" } }, "GetApnsVoipSandboxChannel": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/channels/apns_voip_sandbox", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "APNSVoipSandboxChannelResponse": { "shape": "S57" } }, "required": [ "APNSVoipSandboxChannelResponse" ], "payload": "APNSVoipSandboxChannelResponse" } }, "GetApp": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "ApplicationResponse": { "shape": "S6" } }, "required": [ "ApplicationResponse" ], "payload": "ApplicationResponse" } }, "GetApplicationDateRangeKpi": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/kpis/daterange/{kpi-name}", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "EndTime": { "shape": "S3f", "location": "querystring", "locationName": "end-time" }, "KpiName": { "location": "uri", "locationName": "kpi-name" }, "NextToken": { "location": "querystring", "locationName": "next-token" }, "PageSize": { "location": "querystring", "locationName": "page-size" }, "StartTime": { "shape": "S3f", "location": "querystring", "locationName": "start-time" } }, "required": [ "ApplicationId", "KpiName" ] }, "output": { "type": "structure", "members": { "ApplicationDateRangeKpiResponse": { "type": "structure", "members": { "ApplicationId": {}, "EndTime": { "shape": "S3f" }, "KpiName": {}, "KpiResult": { "shape": "S73" }, "NextToken": {}, "StartTime": { "shape": "S3f" } }, "required": [ "KpiResult", "KpiName", "EndTime", "StartTime", "ApplicationId" ] } }, "required": [ "ApplicationDateRangeKpiResponse" ], "payload": "ApplicationDateRangeKpiResponse" } }, "GetApplicationSettings": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/settings", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "ApplicationSettingsResource": { "shape": "S7a" } }, "required": [ "ApplicationSettingsResource" ], "payload": "ApplicationSettingsResource" } }, "GetApps": { "http": { "method": "GET", "requestUri": "/v1/apps", "responseCode": 200 }, "input": { "type": "structure", "members": { "PageSize": { "location": "querystring", "locationName": "page-size" }, "Token": { "location": "querystring", "locationName": "token" } } }, "output": { "type": "structure", "members": { "ApplicationsResponse": { "type": "structure", "members": { "Item": { "type": "list", "member": { "shape": "S6" } }, "NextToken": {} } } }, "required": [ "ApplicationsResponse" ], "payload": "ApplicationsResponse" } }, "GetBaiduChannel": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/channels/baidu", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "BaiduChannelResponse": { "shape": "S5c" } }, "required": [ "BaiduChannelResponse" ], "payload": "BaiduChannelResponse" } }, "GetCampaign": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "CampaignId": { "location": "uri", "locationName": "campaign-id" } }, "required": [ "CampaignId", "ApplicationId" ] }, "output": { "type": "structure", "members": { "CampaignResponse": { "shape": "S1l" } }, "required": [ "CampaignResponse" ], "payload": "CampaignResponse" } }, "GetCampaignActivities": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}/activities", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "CampaignId": { "location": "uri", "locationName": "campaign-id" }, "PageSize": { "location": "querystring", "locationName": "page-size" }, "Token": { "location": "querystring", "locationName": "token" } }, "required": [ "ApplicationId", "CampaignId" ] }, "output": { "type": "structure", "members": { "ActivitiesResponse": { "type": "structure", "members": { "Item": { "type": "list", "member": { "type": "structure", "members": { "ApplicationId": {}, "CampaignId": {}, "End": {}, "Id": {}, "Result": {}, "ScheduledStart": {}, "Start": {}, "State": {}, "SuccessfulEndpointCount": { "type": "integer" }, "TimezonesCompletedCount": { "type": "integer" }, "TimezonesTotalCount": { "type": "integer" }, "TotalEndpointCount": { "type": "integer" }, "TreatmentId": {}, "ExecutionMetrics": { "shape": "S4" } }, "required": [ "CampaignId", "Id", "ApplicationId" ] } }, "NextToken": {} }, "required": [ "Item" ] } }, "required": [ "ActivitiesResponse" ], "payload": "ActivitiesResponse" } }, "GetCampaignDateRangeKpi": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}/kpis/daterange/{kpi-name}", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "CampaignId": { "location": "uri", "locationName": "campaign-id" }, "EndTime": { "shape": "S3f", "location": "querystring", "locationName": "end-time" }, "KpiName": { "location": "uri", "locationName": "kpi-name" }, "NextToken": { "location": "querystring", "locationName": "next-token" }, "PageSize": { "location": "querystring", "locationName": "page-size" }, "StartTime": { "shape": "S3f", "location": "querystring", "locationName": "start-time" } }, "required": [ "ApplicationId", "KpiName", "CampaignId" ] }, "output": { "type": "structure", "members": { "CampaignDateRangeKpiResponse": { "type": "structure", "members": { "ApplicationId": {}, "CampaignId": {}, "EndTime": { "shape": "S3f" }, "KpiName": {}, "KpiResult": { "shape": "S73" }, "NextToken": {}, "StartTime": { "shape": "S3f" } }, "required": [ "KpiResult", "KpiName", "EndTime", "CampaignId", "StartTime", "ApplicationId" ] } }, "required": [ "CampaignDateRangeKpiResponse" ], "payload": "CampaignDateRangeKpiResponse" } }, "GetCampaignVersion": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}/versions/{version}", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "CampaignId": { "location": "uri", "locationName": "campaign-id" }, "Version": { "location": "uri", "locationName": "version" } }, "required": [ "Version", "ApplicationId", "CampaignId" ] }, "output": { "type": "structure", "members": { "CampaignResponse": { "shape": "S1l" } }, "required": [ "CampaignResponse" ], "payload": "CampaignResponse" } }, "GetCampaignVersions": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}/versions", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "CampaignId": { "location": "uri", "locationName": "campaign-id" }, "PageSize": { "location": "querystring", "locationName": "page-size" }, "Token": { "location": "querystring", "locationName": "token" } }, "required": [ "ApplicationId", "CampaignId" ] }, "output": { "type": "structure", "members": { "CampaignsResponse": { "shape": "S7w" } }, "required": [ "CampaignsResponse" ], "payload": "CampaignsResponse" } }, "GetCampaigns": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/campaigns", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "PageSize": { "location": "querystring", "locationName": "page-size" }, "Token": { "location": "querystring", "locationName": "token" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "CampaignsResponse": { "shape": "S7w" } }, "required": [ "CampaignsResponse" ], "payload": "CampaignsResponse" } }, "GetChannels": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/channels", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "ChannelsResponse": { "type": "structure", "members": { "Channels": { "type": "map", "key": {}, "value": { "type": "structure", "members": { "ApplicationId": {}, "CreationDate": {}, "Enabled": { "type": "boolean" }, "HasCredential": { "type": "boolean" }, "Id": {}, "IsArchived": { "type": "boolean" }, "LastModifiedBy": {}, "LastModifiedDate": {}, "Version": { "type": "integer" } } } } }, "required": [ "Channels" ] } }, "required": [ "ChannelsResponse" ], "payload": "ChannelsResponse" } }, "GetEmailChannel": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/channels/email", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" } }, "required": [ "ApplicationId" ] }, "output": { "type": "structure", "members": { "EmailChannelResponse": { "shape": "S5h" } }, "required": [ "EmailChannelResponse" ], "payload": "EmailChannelResponse" } }, "GetEmailTemplate": { "http": { "method": "GET", "requestUri": "/v1/templates/{template-name}/email", "responseCode": 200 }, "input": { "type": "structure", "members": { "TemplateName": { "location": "uri", "locationName": "template-name" }, "Version": { "location": "querystring", "locationName": "version" } }, "required": [ "TemplateName" ] }, "output": { "type": "structure", "members": { "EmailTemplateResponse": { "type": "structure", "members": { "Arn": {}, "CreationDate": {}, "DefaultSubstitutions": {}, "HtmlPart": {}, "LastModifiedDate": {}, "RecommenderId": {}, "Subject": {}, "Headers": { "shape": "Sl" }, "tags": { "shape": "S4", "locationName": "tags" }, "TemplateDescription": {}, "T