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" }, "operations": { "CreateApp": { "http": { "requestUri": "/v1/apps", "responseCode": 201 }, "input": { "type": "structure", "members": { "CreateApplicationRequest": { "type": "structure", "members": { "Name": {} }, "required": [] } }, "required": [ "CreateApplicationRequest" ], "payload": "CreateApplicationRequest" }, "output": { "type": "structure", "members": { "ApplicationResponse": { "shape": "S5" } }, "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": "S7" } }, "required": [ "ApplicationId", "WriteCampaignRequest" ], "payload": "WriteCampaignRequest" }, "output": { "type": "structure", "members": { "CampaignResponse": { "shape": "S11" } }, "required": [ "CampaignResponse" ], "payload": "CampaignResponse" } }, "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": [] } }, "required": [ "ApplicationId", "ExportJobRequest" ], "payload": "ExportJobRequest" }, "output": { "type": "structure", "members": { "ExportJobResponse": { "shape": "S19" } }, "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": [] } }, "required": [ "ApplicationId", "ImportJobRequest" ], "payload": "ImportJobRequest" }, "output": { "type": "structure", "members": { "ImportJobResponse": { "shape": "S1g" } }, "required": [ "ImportJobResponse" ], "payload": "ImportJobResponse" } }, "CreateSegment": { "http": { "requestUri": "/v1/apps/{application-id}/segments", "responseCode": 201 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "WriteSegmentRequest": { "shape": "S1j" } }, "required": [ "ApplicationId", "WriteSegmentRequest" ], "payload": "WriteSegmentRequest" }, "output": { "type": "structure", "members": { "SegmentResponse": { "shape": "S23" } }, "required": [ "SegmentResponse" ], "payload": "SegmentResponse" } }, "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": "S29" } }, "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": "S2c" } }, "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": "S2f" } }, "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": "S2i" } }, "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": "S2l" } }, "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": "S5" } }, "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": "S2q" } }, "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": "S11" } }, "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": "S2v" } }, "required": [ "EmailChannelResponse" ], "payload": "EmailChannelResponse" } }, "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": "S2y" } }, "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": "S37" } }, "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": "S3a" } }, "required": [ "GCMChannelResponse" ], "payload": "GCMChannelResponse" } }, "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": "S23" } }, "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": "S3f" } }, "required": [ "SMSChannelResponse" ], "payload": "SMSChannelResponse" } }, "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": "S3i" } }, "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": "S3m" } }, "required": [ "VoiceChannelResponse" ], "payload": "VoiceChannelResponse" } }, "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": "S29" } }, "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": "S2c" } }, "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": "S2f" } }, "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": "S2i" } }, "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": "S2l" } }, "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": "S5" } }, "required": [ "ApplicationResponse" ], "payload": "ApplicationResponse" } }, "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": "S41" } }, "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": "S5" } }, "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": "S2q" } }, "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": "S11" } }, "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": {} }, "required": [] } }, "NextToken": {} }, "required": [] } }, "required": [ "ActivitiesResponse" ], "payload": "ActivitiesResponse" } }, "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": "S11" } }, "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": "S4j" } }, "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": "S4j" } }, "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": [] } }, "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": "S2v" } }, "required": [ "EmailChannelResponse" ], "payload": "EmailChannelResponse" } }, "GetEndpoint": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/endpoints/{endpoint-id}", "responseCode": 200 }, "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": "S2y" } }, "required": [ "EndpointResponse" ], "payload": "EndpointResponse" } }, "GetEventStream": { "http": { "method": "GET", "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": "S37" } }, "required": [ "EventStream" ], "payload": "EventStream" } }, "GetExportJob": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/jobs/export/{job-id}", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "JobId": { "location": "uri", "locationName": "job-id" } }, "required": [ "ApplicationId", "JobId" ] }, "output": { "type": "structure", "members": { "ExportJobResponse": { "shape": "S19" } }, "required": [ "ExportJobResponse" ], "payload": "ExportJobResponse" } }, "GetExportJobs": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/jobs/export", "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": { "ExportJobsResponse": { "shape": "S52" } }, "required": [ "ExportJobsResponse" ], "payload": "ExportJobsResponse" } }, "GetGcmChannel": { "http": { "method": "GET", "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": "S3a" } }, "required": [ "GCMChannelResponse" ], "payload": "GCMChannelResponse" } }, "GetImportJob": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/jobs/import/{job-id}", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "JobId": { "location": "uri", "locationName": "job-id" } }, "required": [ "ApplicationId", "JobId" ] }, "output": { "type": "structure", "members": { "ImportJobResponse": { "shape": "S1g" } }, "required": [ "ImportJobResponse" ], "payload": "ImportJobResponse" } }, "GetImportJobs": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/jobs/import", "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": { "ImportJobsResponse": { "shape": "S5a" } }, "required": [ "ImportJobsResponse" ], "payload": "ImportJobsResponse" } }, "GetSegment": { "http": { "method": "GET", "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": "S23" } }, "required": [ "SegmentResponse" ], "payload": "SegmentResponse" } }, "GetSegmentExportJobs": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/segments/{segment-id}/jobs/export", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "PageSize": { "location": "querystring", "locationName": "page-size" }, "SegmentId": { "location": "uri", "locationName": "segment-id" }, "Token": { "location": "querystring", "locationName": "token" } }, "required": [ "SegmentId", "ApplicationId" ] }, "output": { "type": "structure", "members": { "ExportJobsResponse": { "shape": "S52" } }, "required": [ "ExportJobsResponse" ], "payload": "ExportJobsResponse" } }, "GetSegmentImportJobs": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/segments/{segment-id}/jobs/import", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "PageSize": { "location": "querystring", "locationName": "page-size" }, "SegmentId": { "location": "uri", "locationName": "segment-id" }, "Token": { "location": "querystring", "locationName": "token" } }, "required": [ "SegmentId", "ApplicationId" ] }, "output": { "type": "structure", "members": { "ImportJobsResponse": { "shape": "S5a" } }, "required": [ "ImportJobsResponse" ], "payload": "ImportJobsResponse" } }, "GetSegmentVersion": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/segments/{segment-id}/versions/{version}", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "SegmentId": { "location": "uri", "locationName": "segment-id" }, "Version": { "location": "uri", "locationName": "version" } }, "required": [ "SegmentId", "Version", "ApplicationId" ] }, "output": { "type": "structure", "members": { "SegmentResponse": { "shape": "S23" } }, "required": [ "SegmentResponse" ], "payload": "SegmentResponse" } }, "GetSegmentVersions": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/segments/{segment-id}/versions", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "PageSize": { "location": "querystring", "locationName": "page-size" }, "SegmentId": { "location": "uri", "locationName": "segment-id" }, "Token": { "location": "querystring", "locationName": "token" } }, "required": [ "SegmentId", "ApplicationId" ] }, "output": { "type": "structure", "members": { "SegmentsResponse": { "shape": "S5m" } }, "required": [ "SegmentsResponse" ], "payload": "SegmentsResponse" } }, "GetSegments": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/segments", "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": { "SegmentsResponse": { "shape": "S5m" } }, "required": [ "SegmentsResponse" ], "payload": "SegmentsResponse" } }, "GetSmsChannel": { "http": { "method": "GET", "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": "S3f" } }, "required": [ "SMSChannelResponse" ], "payload": "SMSChannelResponse" } }, "GetUserEndpoints": { "http": { "method": "GET", "requestUri": "/v1/apps/{application-id}/users/{user-id}", "responseCode": 200 }, "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": "S3i" } }, "required": [ "EndpointsResponse" ], "payload": "EndpointsResponse" } }, "GetVoiceChannel": { "http": { "method": "GET", "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": "S3m" } }, "required": [ "VoiceChannelResponse" ], "payload": "VoiceChannelResponse" } }, "PhoneNumberValidate": { "http": { "requestUri": "/v1/phone/number/validate", "responseCode": 200 }, "input": { "type": "structure", "members": { "NumberValidateRequest": { "type": "structure", "members": { "IsoCountryCode": {}, "PhoneNumber": {} } } }, "required": [ "NumberValidateRequest" ], "payload": "NumberValidateRequest" }, "output": { "type": "structure", "members": { "NumberValidateResponse": { "type": "structure", "members": { "Carrier": {}, "City": {}, "CleansedPhoneNumberE164": {}, "CleansedPhoneNumberNational": {}, "Country": {}, "CountryCodeIso2": {}, "CountryCodeNumeric": {}, "County": {}, "OriginalCountryCodeIso2": {}, "OriginalPhoneNumber": {}, "PhoneType": {}, "PhoneTypeCode": { "type": "integer" }, "Timezone": {}, "ZipCode": {} } } }, "required": [ "NumberValidateResponse" ], "payload": "NumberValidateResponse" } }, "PutEventStream": { "http": { "requestUri": "/v1/apps/{application-id}/eventstream", "responseCode": 200 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "WriteEventStream": { "type": "structure", "members": { "DestinationStreamArn": {}, "RoleArn": {} }, "required": [] } }, "required": [ "ApplicationId", "WriteEventStream" ], "payload": "WriteEventStream" }, "output": { "type": "structure", "members": { "EventStream": { "shape": "S37" } }, "required": [ "EventStream" ], "payload": "EventStream" } }, "PutEvents": { "http": { "requestUri": "/v1/apps/{application-id}/events", "responseCode": 202 }, "input": { "type": "structure", "members": { "ApplicationId": { "location": "uri", "locationName": "application-id" }, "EventsRequest": { "type": "structure", "members": { "BatchItem": { "type": "map", "key": {}, "value": { "type": "structure", "members": { "Endpoint": { "type": "structure", "members": { "Address": {}, "Attributes": { "shape": "S2z" }, "ChannelType": {}, "Demographic": { "shape": "S31" }, "EffectiveDate": {}, "EndpointStatus": {}, "Location": { "shape": "S32" }, "Metrics": { "shape": "S33" }, "OptOut": {}, "RequestId": {}, "User": { "shape": "S34" } } }, "Events": { "type": "map", "key": {}, "value": { "type": "structure", "members": { "Attributes": { "shape": "S6a"