dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-botocore/botocore/data/pinpoint/2016-12-01/service-2.json
TANIGUCHI Takaki a73c3c192a New upstream version 1.5.7
2017-02-02 17:27:08 +09:00

3217 lines
100 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"metadata" : {
"apiVersion" : "2016-12-01",
"endpointPrefix" : "pinpoint",
"signingName" : "mobiletargeting",
"signatureVersion":"v4",
"serviceFullName" : "Amazon Pinpoint",
"protocol" : "rest-json",
"jsonVersion" : "1.1"
},
"operations" : {
"CreateCampaign" : {
"name" : "CreateCampaign",
"http" : {
"method" : "POST",
"requestUri" : "/v1/apps/{application-id}/campaigns",
"responseCode" : 201
},
"input" : {
"shape" : "CreateCampaignRequest"
},
"output" : {
"shape" : "CreateCampaignResponse",
"documentation" : "201 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Creates or updates a campaign."
},
"CreateImportJob" : {
"name" : "CreateImportJob",
"http" : {
"method" : "POST",
"requestUri" : "/v1/apps/{application-id}/jobs/import",
"responseCode" : 201
},
"input" : {
"shape" : "CreateImportJobRequest"
},
"output" : {
"shape" : "CreateImportJobResponse",
"documentation" : "201 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Creates or updates an import job."
},
"CreateSegment" : {
"name" : "CreateSegment",
"http" : {
"method" : "POST",
"requestUri" : "/v1/apps/{application-id}/segments",
"responseCode" : 201
},
"input" : {
"shape" : "CreateSegmentRequest"
},
"output" : {
"shape" : "CreateSegmentResponse",
"documentation" : "201 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Used to create or update a segment."
},
"DeleteApnsChannel" : {
"name" : "DeleteApnsChannel",
"http" : {
"method" : "DELETE",
"requestUri" : "/v1/apps/{application-id}/channels/apns",
"responseCode" : 200
},
"input" : {
"shape" : "DeleteApnsChannelRequest"
},
"output" : {
"shape" : "DeleteApnsChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Deletes the APNs channel for an app."
},
"DeleteCampaign" : {
"name" : "DeleteCampaign",
"http" : {
"method" : "DELETE",
"requestUri" : "/v1/apps/{application-id}/campaigns/{campaign-id}",
"responseCode" : 200
},
"input" : {
"shape" : "DeleteCampaignRequest"
},
"output" : {
"shape" : "DeleteCampaignResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Deletes a campaign."
},
"DeleteGcmChannel" : {
"name" : "DeleteGcmChannel",
"http" : {
"method" : "DELETE",
"requestUri" : "/v1/apps/{application-id}/channels/gcm",
"responseCode" : 200
},
"input" : {
"shape" : "DeleteGcmChannelRequest"
},
"output" : {
"shape" : "DeleteGcmChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Deletes the GCM channel for an app."
},
"DeleteSegment" : {
"name" : "DeleteSegment",
"http" : {
"method" : "DELETE",
"requestUri" : "/v1/apps/{application-id}/segments/{segment-id}",
"responseCode" : 200
},
"input" : {
"shape" : "DeleteSegmentRequest"
},
"output" : {
"shape" : "DeleteSegmentResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Deletes a segment."
},
"GetApnsChannel" : {
"name" : "GetApnsChannel",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/channels/apns",
"responseCode" : 200
},
"input" : {
"shape" : "GetApnsChannelRequest"
},
"output" : {
"shape" : "GetApnsChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about the APNs channel for an app."
},
"GetApplicationSettings" : {
"name" : "GetApplicationSettings",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/settings",
"responseCode" : 200
},
"input" : {
"shape" : "GetApplicationSettingsRequest"
},
"output" : {
"shape" : "GetApplicationSettingsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Used to request the settings for an app."
},
"GetCampaign" : {
"name" : "GetCampaign",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/campaigns/{campaign-id}",
"responseCode" : 200
},
"input" : {
"shape" : "GetCampaignRequest"
},
"output" : {
"shape" : "GetCampaignResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about a campaign."
},
"GetCampaignActivities" : {
"name" : "GetCampaignActivities",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/campaigns/{campaign-id}/activities",
"responseCode" : 200
},
"input" : {
"shape" : "GetCampaignActivitiesRequest"
},
"output" : {
"shape" : "GetCampaignActivitiesResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about the activity performed by a campaign."
},
"GetCampaignVersion" : {
"name" : "GetCampaignVersion",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/campaigns/{campaign-id}/versions/{version}",
"responseCode" : 200
},
"input" : {
"shape" : "GetCampaignVersionRequest"
},
"output" : {
"shape" : "GetCampaignVersionResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about your campaign versions."
},
"GetCampaignVersions" : {
"name" : "GetCampaignVersions",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/campaigns/{campaign-id}/versions",
"responseCode" : 200
},
"input" : {
"shape" : "GetCampaignVersionsRequest"
},
"output" : {
"shape" : "GetCampaignVersionsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about your campaign versions."
},
"GetCampaigns" : {
"name" : "GetCampaigns",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/campaigns",
"responseCode" : 200
},
"input" : {
"shape" : "GetCampaignsRequest"
},
"output" : {
"shape" : "GetCampaignsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about your campaigns."
},
"GetEndpoint" : {
"name" : "GetEndpoint",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/endpoints/{endpoint-id}",
"responseCode" : 200
},
"input" : {
"shape" : "GetEndpointRequest"
},
"output" : {
"shape" : "GetEndpointResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about an endpoint."
},
"GetGcmChannel" : {
"name" : "GetGcmChannel",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/channels/gcm",
"responseCode" : 200
},
"input" : {
"shape" : "GetGcmChannelRequest"
},
"output" : {
"shape" : "GetGcmChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about the GCM channel for an app."
},
"GetImportJob" : {
"name" : "GetImportJob",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/jobs/import/{job-id}",
"responseCode" : 200
},
"input" : {
"shape" : "GetImportJobRequest"
},
"output" : {
"shape" : "GetImportJobResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about an import job."
},
"GetImportJobs" : {
"name" : "GetImportJobs",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/jobs/import",
"responseCode" : 200
},
"input" : {
"shape" : "GetImportJobsRequest"
},
"output" : {
"shape" : "GetImportJobsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about your import jobs."
},
"GetSegment" : {
"name" : "GetSegment",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/segments/{segment-id}",
"responseCode" : 200
},
"input" : {
"shape" : "GetSegmentRequest"
},
"output" : {
"shape" : "GetSegmentResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about a segment."
},
"GetSegmentImportJobs" : {
"name" : "GetSegmentImportJobs",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/segments/{segment-id}/jobs/import",
"responseCode" : 200
},
"input" : {
"shape" : "GetSegmentImportJobsRequest"
},
"output" : {
"shape" : "GetSegmentImportJobsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns a list of import jobs for a specific segment."
},
"GetSegmentVersion" : {
"name" : "GetSegmentVersion",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/segments/{segment-id}/versions/{version}",
"responseCode" : 200
},
"input" : {
"shape" : "GetSegmentVersionRequest"
},
"output" : {
"shape" : "GetSegmentVersionResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about a segment version."
},
"GetSegmentVersions" : {
"name" : "GetSegmentVersions",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/segments/{segment-id}/versions",
"responseCode" : 200
},
"input" : {
"shape" : "GetSegmentVersionsRequest"
},
"output" : {
"shape" : "GetSegmentVersionsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about your segment versions."
},
"GetSegments" : {
"name" : "GetSegments",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/segments",
"responseCode" : 200
},
"input" : {
"shape" : "GetSegmentsRequest"
},
"output" : {
"shape" : "GetSegmentsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Used to get information about your segments."
},
"UpdateApnsChannel" : {
"name" : "UpdateApnsChannel",
"http" : {
"method" : "PUT",
"requestUri" : "/v1/apps/{application-id}/channels/apns",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateApnsChannelRequest"
},
"output" : {
"shape" : "UpdateApnsChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use to update the APNs channel for an app."
},
"UpdateApplicationSettings" : {
"name" : "UpdateApplicationSettings",
"http" : {
"method" : "PUT",
"requestUri" : "/v1/apps/{application-id}/settings",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateApplicationSettingsRequest"
},
"output" : {
"shape" : "UpdateApplicationSettingsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Used to update the settings for an app."
},
"UpdateCampaign" : {
"name" : "UpdateCampaign",
"http" : {
"method" : "PUT",
"requestUri" : "/v1/apps/{application-id}/campaigns/{campaign-id}",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateCampaignRequest"
},
"output" : {
"shape" : "UpdateCampaignResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use to update a campaign."
},
"UpdateEndpoint" : {
"name" : "UpdateEndpoint",
"http" : {
"method" : "PUT",
"requestUri" : "/v1/apps/{application-id}/endpoints/{endpoint-id}",
"responseCode" : 202
},
"input" : {
"shape" : "UpdateEndpointRequest"
},
"output" : {
"shape" : "UpdateEndpointResponse",
"documentation" : "202 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use to update an endpoint."
},
"UpdateEndpointsBatch" : {
"name" : "UpdateEndpointsBatch",
"http" : {
"method" : "PUT",
"requestUri" : "/v1/apps/{application-id}/endpoints",
"responseCode" : 202
},
"input" : {
"shape" : "UpdateEndpointsBatchRequest"
},
"output" : {
"shape" : "UpdateEndpointsBatchResponse",
"documentation" : "202 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use to update your endpoints."
},
"UpdateGcmChannel" : {
"name" : "UpdateGcmChannel",
"http" : {
"method" : "PUT",
"requestUri" : "/v1/apps/{application-id}/channels/gcm",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateGcmChannelRequest"
},
"output" : {
"shape" : "UpdateGcmChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use to update the GCM channel for an app."
},
"UpdateSegment" : {
"name" : "UpdateSegment",
"http" : {
"method" : "PUT",
"requestUri" : "/v1/apps/{application-id}/segments/{segment-id}",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateSegmentRequest"
},
"output" : {
"shape" : "UpdateSegmentResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use to update a segment."
}
},
"shapes" : {
"APNSChannelRequest" : {
"type" : "structure",
"members" : {
"Certificate" : {
"shape" : "__string",
"documentation" : "The distribution certificate from Apple."
},
"PrivateKey" : {
"shape" : "__string",
"documentation" : "The certificate private key."
}
}
},
"APNSChannelResponse" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string"
},
"CreationDate" : {
"shape" : "__string",
"documentation" : "When was this segment created"
},
"Id" : {
"shape" : "__string"
},
"IsArchived" : {
"shape" : "__boolean",
"documentation" : "Is this channel archived"
},
"LastModifiedBy" : {
"shape" : "__string",
"documentation" : "Who last updated this entry"
},
"LastModifiedDate" : {
"shape" : "__string",
"documentation" : "Last date this was updated"
},
"Platform" : {
"shape" : "__string",
"documentation" : "The platform type. Will be APNS."
},
"Version" : {
"shape" : "__integer",
"documentation" : "Version of channel"
}
}
},
"Action" : {
"type" : "string",
"enum" : [ "OPEN_APP", "DEEP_LINK", "URL" ]
},
"ActivitiesResponse" : {
"type" : "structure",
"members" : {
"Item" : {
"shape" : "ListOfActivityResponse",
"documentation" : "List of campaign activities"
}
}
},
"ActivityResponse" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"documentation" : "The ID of the application to which the campaign applies."
},
"CampaignId" : {
"shape" : "__string",
"documentation" : "The ID of the campaign to which the activity applies."
},
"End" : {
"shape" : "__string",
"documentation" : "The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format."
},
"Id" : {
"shape" : "__string",
"documentation" : "The unique activity ID."
},
"Result" : {
"shape" : "__string",
"documentation" : "Indicates whether the activity succeeded.\n\nValid values: SUCCESS, FAIL"
},
"ScheduledStart" : {
"shape" : "__string",
"documentation" : "The scheduled start time for the activity in ISO 8601 format."
},
"Start" : {
"shape" : "__string",
"documentation" : "The actual start time of the activity in ISO 8601 format."
},
"State" : {
"shape" : "__string",
"documentation" : "The state of the activity.\n\nValid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED"
},
"SuccessfulEndpointCount" : {
"shape" : "__integer",
"documentation" : "The total number of endpoints to which the campaign successfully delivered messages."
},
"TotalEndpointCount" : {
"shape" : "__integer",
"documentation" : "The total number of endpoints to which the campaign attempts to deliver messages."
},
"TreatmentId" : {
"shape" : "__string",
"documentation" : "The ID of a variation of the campaign used for A/B testing."
}
}
},
"ApplicationSettingsResource" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"documentation" : "The unique ID for the application."
},
"LastModifiedDate" : {
"shape" : "__string",
"documentation" : "The date that the settings were last updated in ISO 8601 format."
},
"Limits" : {
"shape" : "CampaignLimits",
"documentation" : "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."
},
"QuietTime" : {
"shape" : "QuietTime",
"documentation" : "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."
}
}
},
"AttributeDimension" : {
"type" : "structure",
"members" : {
"AttributeType" : {
"shape" : "AttributeType",
"documentation" : "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."
},
"Values" : {
"shape" : "ListOf__string",
"documentation" : "The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type."
}
}
},
"AttributeType" : {
"type" : "string",
"enum" : [ "INCLUSIVE", "EXCLUSIVE" ]
},
"BadRequestException" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string"
}
},
"exception" : true,
"error" : {
"httpStatusCode" : 400
}
},
"CampaignLimits" : {
"type" : "structure",
"members" : {
"Daily" : {
"shape" : "__integer",
"documentation" : "The maximum number of messages that the campaign can send daily."
},
"Total" : {
"shape" : "__integer",
"documentation" : "The maximum total number of messages that the campaign can send."
}
}
},
"CampaignResponse" : {
"type" : "structure",
"members" : {
"AdditionalTreatments" : {
"shape" : "ListOfTreatmentResource",
"documentation" : "Treatments that are defined in addition to the default treatment."
},
"ApplicationId" : {
"shape" : "__string",
"documentation" : "The ID of the application to which the campaign applies."
},
"CreationDate" : {
"shape" : "__string",
"documentation" : "The date the campaign was created in ISO 8601 format."
},
"DefaultState" : {
"shape" : "CampaignState",
"documentation" : "The status of the campaign's default treatment. Only present for A/B test campaigns."
},
"Description" : {
"shape" : "__string",
"documentation" : "A description of the campaign."
},
"HoldoutPercent" : {
"shape" : "__integer",
"documentation" : "The allocated percentage of end users who will not receive messages from this campaign."
},
"Id" : {
"shape" : "__string",
"documentation" : "The unique campaign ID."
},
"IsPaused" : {
"shape" : "__boolean",
"documentation" : "Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false."
},
"LastModifiedDate" : {
"shape" : "__string",
"documentation" : "The date the campaign was last updated in ISO 8601 format.\t"
},
"Limits" : {
"shape" : "CampaignLimits",
"documentation" : "The campaign limits settings."
},
"MessageConfiguration" : {
"shape" : "MessageConfiguration",
"documentation" : "The message configuration settings."
},
"Name" : {
"shape" : "__string",
"documentation" : "The custom name of the campaign."
},
"Schedule" : {
"shape" : "Schedule",
"documentation" : "The campaign schedule."
},
"SegmentId" : {
"shape" : "__string",
"documentation" : "The ID of the segment to which the campaign sends messages."
},
"SegmentVersion" : {
"shape" : "__integer",
"documentation" : "The version of the segment to which the campaign sends messages."
},
"State" : {
"shape" : "CampaignState",
"documentation" : "The campaign status.\n\nAn A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED."
},
"TreatmentDescription" : {
"shape" : "__string",
"documentation" : "A custom description for the treatment."
},
"TreatmentName" : {
"shape" : "__string",
"documentation" : "The custom name of a variation of the campaign used for A/B testing."
},
"Version" : {
"shape" : "__integer",
"documentation" : "The campaign version number."
}
}
},
"CampaignState" : {
"type" : "structure",
"members" : {
"CampaignStatus" : {
"shape" : "CampaignStatus",
"documentation" : "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"
}
}
},
"CampaignStatus" : {
"type" : "string",
"enum" : [ "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED" ]
},
"CampaignsResponse" : {
"type" : "structure",
"members" : {
"Item" : {
"shape" : "ListOfCampaignResponse",
"documentation" : "A list of campaigns."
},
"NextToken" : {
"shape" : "__string",
"documentation" : "The string that you use in a subsequent request to get the next page of results in a paginated response."
}
}
},
"ChannelType" : {
"type" : "string",
"enum" : [ "APNS", "GCM" ]
},
"CreateCampaignRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"WriteCampaignRequest" : {
"shape" : "WriteCampaignRequest"
}
},
"required" : [ "ApplicationId", "WriteCampaignRequest" ],
"payload" : "WriteCampaignRequest"
},
"CreateCampaignResponse" : {
"type" : "structure",
"members" : {
"CampaignResponse" : {
"shape" : "CampaignResponse"
}
},
"required" : [ "CampaignResponse" ],
"payload" : "CampaignResponse"
},
"CreateImportJobRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"ImportJobRequest" : {
"shape" : "ImportJobRequest"
}
},
"required" : [ "ApplicationId", "ImportJobRequest" ],
"payload" : "ImportJobRequest"
},
"CreateImportJobResponse" : {
"type" : "structure",
"members" : {
"ImportJobResponse" : {
"shape" : "ImportJobResponse"
}
},
"required" : [ "ImportJobResponse" ],
"payload" : "ImportJobResponse"
},
"CreateSegmentRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"WriteSegmentRequest" : {
"shape" : "WriteSegmentRequest"
}
},
"required" : [ "ApplicationId", "WriteSegmentRequest" ],
"payload" : "WriteSegmentRequest"
},
"CreateSegmentResponse" : {
"type" : "structure",
"members" : {
"SegmentResponse" : {
"shape" : "SegmentResponse"
}
},
"required" : [ "SegmentResponse" ],
"payload" : "SegmentResponse"
},
"DeleteApnsChannelRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
}
},
"required" : [ "ApplicationId" ]
},
"DeleteApnsChannelResponse" : {
"type" : "structure",
"members" : {
"APNSChannelResponse" : {
"shape" : "APNSChannelResponse"
}
},
"required" : [ "APNSChannelResponse" ],
"payload" : "APNSChannelResponse"
},
"DeleteCampaignRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"CampaignId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "campaign-id"
}
},
"required" : [ "CampaignId", "ApplicationId" ]
},
"DeleteCampaignResponse" : {
"type" : "structure",
"members" : {
"CampaignResponse" : {
"shape" : "CampaignResponse"
}
},
"required" : [ "CampaignResponse" ],
"payload" : "CampaignResponse"
},
"DeleteGcmChannelRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
}
},
"required" : [ "ApplicationId" ]
},
"DeleteGcmChannelResponse" : {
"type" : "structure",
"members" : {
"GCMChannelResponse" : {
"shape" : "GCMChannelResponse"
}
},
"required" : [ "GCMChannelResponse" ],
"payload" : "GCMChannelResponse"
},
"DeleteSegmentRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"SegmentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "segment-id"
}
},
"required" : [ "SegmentId", "ApplicationId" ]
},
"DeleteSegmentResponse" : {
"type" : "structure",
"members" : {
"SegmentResponse" : {
"shape" : "SegmentResponse"
}
},
"required" : [ "SegmentResponse" ],
"payload" : "SegmentResponse"
},
"DimensionType" : {
"type" : "string",
"enum" : [ "INCLUSIVE", "EXCLUSIVE" ]
},
"Duration" : {
"type" : "string",
"enum" : [ "HR_24", "DAY_7", "DAY_14", "DAY_30" ]
},
"EndpointBatchItem" : {
"type" : "structure",
"members" : {
"Address" : {
"shape" : "__string",
"documentation" : "The address or token of the endpoint."
},
"Attributes" : {
"shape" : "MapOfListOf__string",
"documentation" : "Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment."
},
"ChannelType" : {
"shape" : "ChannelType",
"documentation" : "The channel type.\n\nValid values: APNS, GCM"
},
"Demographic" : {
"shape" : "EndpointDemographic",
"documentation" : "The endpoint demographic attributes."
},
"EffectiveDate" : {
"shape" : "__string",
"documentation" : "The last time the endpoint was updated. Provided in ISO 8601 format."
},
"EndpointStatus" : {
"shape" : "__string",
"documentation" : "The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated."
},
"Id" : {
"shape" : "__string"
},
"Location" : {
"shape" : "EndpointLocation",
"documentation" : "The endpoint location attributes."
},
"Metrics" : {
"shape" : "MapOf__double",
"documentation" : "Custom metrics that your app reports to Amazon Pinpoint."
},
"OptOut" : {
"shape" : "__string",
"documentation" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL – User receives all messages.\nNONE – User receives no messages."
},
"RequestId" : {
"shape" : "__string",
"documentation" : "The unique ID for the most recent request to update the endpoint."
},
"User" : {
"shape" : "EndpointUser",
"documentation" : "Custom user-specific attributes that your app reports to Amazon Pinpoint."
}
}
},
"EndpointBatchRequest" : {
"type" : "structure",
"members" : {
"Item" : {
"shape" : "ListOfEndpointBatchItem",
"documentation" : "List of items to update. Maximum 100 items"
}
}
},
"EndpointDemographic" : {
"type" : "structure",
"members" : {
"AppVersion" : {
"shape" : "__string",
"documentation" : "The version of the application associated with the endpoint."
},
"Locale" : {
"shape" : "__string",
"documentation" : "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"
},
"Make" : {
"shape" : "__string",
"documentation" : "The endpoint make, such as such as Apple or Samsung."
},
"Model" : {
"shape" : "__string",
"documentation" : "The endpoint model, such as iPhone."
},
"ModelVersion" : {
"shape" : "__string",
"documentation" : "The endpoint model version."
},
"Platform" : {
"shape" : "__string",
"documentation" : "The endpoint platform, such as ios or android."
},
"PlatformVersion" : {
"shape" : "__string",
"documentation" : "The endpoint platform version."
},
"Timezone" : {
"shape" : "__string",
"documentation" : "The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles."
}
}
},
"EndpointLocation" : {
"type" : "structure",
"members" : {
"City" : {
"shape" : "__string",
"documentation" : "The city where the endpoint is located."
},
"Country" : {
"shape" : "__string",
"documentation" : "Country according to ISO 3166-1 Alpha-2 codes. For example, US."
},
"Latitude" : {
"shape" : "__double",
"documentation" : "The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile)."
},
"Longitude" : {
"shape" : "__double",
"documentation" : "The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile)."
},
"PostalCode" : {
"shape" : "__string",
"documentation" : "The postal code or zip code of the endpoint."
},
"Region" : {
"shape" : "__string",
"documentation" : "The region of the endpoint location. For example, corresponds to a state in US."
}
}
},
"EndpointRequest" : {
"type" : "structure",
"members" : {
"Address" : {
"shape" : "__string",
"documentation" : "The address or token of the endpoint."
},
"Attributes" : {
"shape" : "MapOfListOf__string",
"documentation" : "Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment."
},
"ChannelType" : {
"shape" : "ChannelType",
"documentation" : "The channel type.\n\nValid values: APNS, GCM"
},
"Demographic" : {
"shape" : "EndpointDemographic",
"documentation" : "The endpoint demographic attributes."
},
"EffectiveDate" : {
"shape" : "__string",
"documentation" : "The last time the endpoint was updated. Provided in ISO 8601 format."
},
"EndpointStatus" : {
"shape" : "__string",
"documentation" : "The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated."
},
"Location" : {
"shape" : "EndpointLocation",
"documentation" : "The endpoint location attributes."
},
"Metrics" : {
"shape" : "MapOf__double",
"documentation" : "Custom metrics that your app reports to Amazon Pinpoint."
},
"OptOut" : {
"shape" : "__string",
"documentation" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL – User receives all messages.\nNONE – User receives no messages."
},
"RequestId" : {
"shape" : "__string",
"documentation" : "The unique ID for the most recent request to update the endpoint."
},
"User" : {
"shape" : "EndpointUser",
"documentation" : "Custom user-specific attributes that your app reports to Amazon Pinpoint."
}
}
},
"EndpointResponse" : {
"type" : "structure",
"members" : {
"Address" : {
"shape" : "__string",
"documentation" : "The address or token of the endpoint."
},
"ApplicationId" : {
"shape" : "__string",
"documentation" : "The ID of the application associated with the endpoint."
},
"Attributes" : {
"shape" : "MapOfListOf__string",
"documentation" : "Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment."
},
"ChannelType" : {
"shape" : "ChannelType",
"documentation" : "The channel type.\n\nValid values: APNS, GCM"
},
"CohortId" : {
"shape" : "__string",
"documentation" : "A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign."
},
"CreationDate" : {
"shape" : "__string",
"documentation" : "The last time the endpoint was created. Provided in ISO 8601 format."
},
"Demographic" : {
"shape" : "EndpointDemographic",
"documentation" : "The endpoint demographic attributes."
},
"EffectiveDate" : {
"shape" : "__string",
"documentation" : "The last time the endpoint was updated. Provided in ISO 8601 format."
},
"EndpointStatus" : {
"shape" : "__string",
"documentation" : "The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated."
},
"Id" : {
"shape" : "__string",
"documentation" : "The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application."
},
"Location" : {
"shape" : "EndpointLocation",
"documentation" : "The endpoint location attributes."
},
"Metrics" : {
"shape" : "MapOf__double",
"documentation" : "Custom metrics that your app reports to Amazon Pinpoint."
},
"OptOut" : {
"shape" : "__string",
"documentation" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL – User receives all messages.\nNONE – User receives no messages."
},
"RequestId" : {
"shape" : "__string",
"documentation" : "The unique ID for the most recent request to update the endpoint."
},
"ShardId" : {
"shape" : "__string",
"documentation" : "The ShardId of endpoint"
},
"User" : {
"shape" : "EndpointUser",
"documentation" : "Custom user-specific attributes that your app reports to Amazon Pinpoint."
}
}
},
"EndpointUser" : {
"type" : "structure",
"members" : {
"UserAttributes" : {
"shape" : "MapOfListOf__string",
"documentation" : "Custom attributesd specific to the user."
},
"UserId" : {
"shape" : "__string",
"documentation" : "The unique ID of the user."
}
}
},
"ForbiddenException" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string"
}
},
"exception" : true,
"error" : {
"httpStatusCode" : 403
}
},
"Format" : {
"type" : "string",
"enum" : [ "CSV", "JSON" ]
},
"Frequency" : {
"type" : "string",
"enum" : [ "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY" ]
},
"GCMChannelRequest" : {
"type" : "structure",
"members" : {
"ApiKey" : {
"shape" : "__string",
"documentation" : "Platform credential API key from Google."
}
}
},
"GCMChannelResponse" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string"
},
"CreationDate" : {
"shape" : "__string",
"documentation" : "When was this segment created"
},
"Credential" : {
"shape" : "__string",
"documentation" : "The GCM API key from Google."
},
"Id" : {
"shape" : "__string"
},
"IsArchived" : {
"shape" : "__boolean",
"documentation" : "Is this channel archived"
},
"LastModifiedBy" : {
"shape" : "__string",
"documentation" : "Who last updated this entry"
},
"LastModifiedDate" : {
"shape" : "__string",
"documentation" : "Last date this was updated"
},
"Platform" : {
"shape" : "__string",
"documentation" : "The platform type. Will be GCM"
},
"Version" : {
"shape" : "__integer",
"documentation" : "Version of channel"
}
}
},
"GetApnsChannelRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
}
},
"required" : [ "ApplicationId" ]
},
"GetApnsChannelResponse" : {
"type" : "structure",
"members" : {
"APNSChannelResponse" : {
"shape" : "APNSChannelResponse"
}
},
"required" : [ "APNSChannelResponse" ],
"payload" : "APNSChannelResponse"
},
"GetApplicationSettingsRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
}
},
"required" : [ "ApplicationId" ]
},
"GetApplicationSettingsResponse" : {
"type" : "structure",
"members" : {
"ApplicationSettingsResource" : {
"shape" : "ApplicationSettingsResource"
}
},
"required" : [ "ApplicationSettingsResource" ],
"payload" : "ApplicationSettingsResource"
},
"GetCampaignActivitiesRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"CampaignId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "campaign-id"
},
"PageSize" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "page-size"
},
"Token" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "token"
}
},
"required" : [ "ApplicationId", "CampaignId" ]
},
"GetCampaignActivitiesResponse" : {
"type" : "structure",
"members" : {
"ActivitiesResponse" : {
"shape" : "ActivitiesResponse"
}
},
"required" : [ "ActivitiesResponse" ],
"payload" : "ActivitiesResponse"
},
"GetCampaignRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"CampaignId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "campaign-id"
}
},
"required" : [ "CampaignId", "ApplicationId" ]
},
"GetCampaignResponse" : {
"type" : "structure",
"members" : {
"CampaignResponse" : {
"shape" : "CampaignResponse"
}
},
"required" : [ "CampaignResponse" ],
"payload" : "CampaignResponse"
},
"GetCampaignVersionRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"CampaignId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "campaign-id"
},
"Version" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "version"
}
},
"required" : [ "Version", "ApplicationId", "CampaignId" ]
},
"GetCampaignVersionResponse" : {
"type" : "structure",
"members" : {
"CampaignResponse" : {
"shape" : "CampaignResponse"
}
},
"required" : [ "CampaignResponse" ],
"payload" : "CampaignResponse"
},
"GetCampaignVersionsRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"CampaignId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "campaign-id"
},
"PageSize" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "page-size"
},
"Token" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "token"
}
},
"required" : [ "ApplicationId", "CampaignId" ]
},
"GetCampaignVersionsResponse" : {
"type" : "structure",
"members" : {
"CampaignsResponse" : {
"shape" : "CampaignsResponse"
}
},
"required" : [ "CampaignsResponse" ],
"payload" : "CampaignsResponse"
},
"GetCampaignsRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"PageSize" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "page-size"
},
"Token" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "token"
}
},
"required" : [ "ApplicationId" ]
},
"GetCampaignsResponse" : {
"type" : "structure",
"members" : {
"CampaignsResponse" : {
"shape" : "CampaignsResponse"
}
},
"required" : [ "CampaignsResponse" ],
"payload" : "CampaignsResponse"
},
"GetEndpointRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"EndpointId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "endpoint-id"
}
},
"required" : [ "ApplicationId", "EndpointId" ]
},
"GetEndpointResponse" : {
"type" : "structure",
"members" : {
"EndpointResponse" : {
"shape" : "EndpointResponse"
}
},
"required" : [ "EndpointResponse" ],
"payload" : "EndpointResponse"
},
"GetGcmChannelRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
}
},
"required" : [ "ApplicationId" ]
},
"GetGcmChannelResponse" : {
"type" : "structure",
"members" : {
"GCMChannelResponse" : {
"shape" : "GCMChannelResponse"
}
},
"required" : [ "GCMChannelResponse" ],
"payload" : "GCMChannelResponse"
},
"GetImportJobRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"JobId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "job-id"
}
},
"required" : [ "ApplicationId", "JobId" ]
},
"GetImportJobResponse" : {
"type" : "structure",
"members" : {
"ImportJobResponse" : {
"shape" : "ImportJobResponse"
}
},
"required" : [ "ImportJobResponse" ],
"payload" : "ImportJobResponse"
},
"GetImportJobsRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"PageSize" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "page-size"
},
"Token" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "token"
}
},
"required" : [ "ApplicationId" ]
},
"GetImportJobsResponse" : {
"type" : "structure",
"members" : {
"ImportJobsResponse" : {
"shape" : "ImportJobsResponse"
}
},
"required" : [ "ImportJobsResponse" ],
"payload" : "ImportJobsResponse"
},
"GetSegmentImportJobsRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"PageSize" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "page-size"
},
"SegmentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "segment-id"
},
"Token" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "token"
}
},
"required" : [ "SegmentId", "ApplicationId" ]
},
"GetSegmentImportJobsResponse" : {
"type" : "structure",
"members" : {
"ImportJobsResponse" : {
"shape" : "ImportJobsResponse"
}
},
"required" : [ "ImportJobsResponse" ],
"payload" : "ImportJobsResponse"
},
"GetSegmentRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"SegmentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "segment-id"
}
},
"required" : [ "SegmentId", "ApplicationId" ]
},
"GetSegmentResponse" : {
"type" : "structure",
"members" : {
"SegmentResponse" : {
"shape" : "SegmentResponse"
}
},
"required" : [ "SegmentResponse" ],
"payload" : "SegmentResponse"
},
"GetSegmentVersionRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"SegmentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "segment-id"
},
"Version" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "version"
}
},
"required" : [ "SegmentId", "Version", "ApplicationId" ]
},
"GetSegmentVersionResponse" : {
"type" : "structure",
"members" : {
"SegmentResponse" : {
"shape" : "SegmentResponse"
}
},
"required" : [ "SegmentResponse" ],
"payload" : "SegmentResponse"
},
"GetSegmentVersionsRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"PageSize" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "page-size"
},
"SegmentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "segment-id"
},
"Token" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "token"
}
},
"required" : [ "SegmentId", "ApplicationId" ]
},
"GetSegmentVersionsResponse" : {
"type" : "structure",
"members" : {
"SegmentsResponse" : {
"shape" : "SegmentsResponse"
}
},
"required" : [ "SegmentsResponse" ],
"payload" : "SegmentsResponse"
},
"GetSegmentsRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"PageSize" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "page-size"
},
"Token" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "token"
}
},
"required" : [ "ApplicationId" ]
},
"GetSegmentsResponse" : {
"type" : "structure",
"members" : {
"SegmentsResponse" : {
"shape" : "SegmentsResponse"
}
},
"required" : [ "SegmentsResponse" ],
"payload" : "SegmentsResponse"
},
"ImportJobRequest" : {
"type" : "structure",
"members" : {
"DefineSegment" : {
"shape" : "__boolean",
"documentation" : "Sets whether the endpoints create a segment when they are imported."
},
"ExternalId" : {
"shape" : "__string",
"documentation" : "A unique, custom ID assigned to the IAM role that restricts who can assume the role.\t"
},
"Format" : {
"shape" : "Format",
"documentation" : "The format of the files that contain the endpoint definitions.\nValid values: CSV, JSON"
},
"RegisterEndpoints" : {
"shape" : "__boolean",
"documentation" : "Sets whether the endpoints are registered with Amazon Pinpoint when they are imported."
},
"RoleArn" : {
"shape" : "__string",
"documentation" : "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."
},
"S3Url" : {
"shape" : "__string",
"documentation" : "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."
},
"SegmentId" : {
"shape" : "__string",
"documentation" : "The ID of the segment to update if the import job is meant to update an existing segment."
},
"SegmentName" : {
"shape" : "__string",
"documentation" : "A custom name for the segment created by the import job. Use if DefineSegment is true."
}
}
},
"ImportJobResource" : {
"type" : "structure",
"members" : {
"DefineSegment" : {
"shape" : "__boolean",
"documentation" : "Sets whether the endpoints create a segment when they are imported."
},
"ExternalId" : {
"shape" : "__string",
"documentation" : "A unique, custom ID assigned to the IAM role that restricts who can assume the role.\t"
},
"Format" : {
"shape" : "Format",
"documentation" : "The format of the files that contain the endpoint definitions.\nValid values: CSV, JSON"
},
"RegisterEndpoints" : {
"shape" : "__boolean",
"documentation" : "Sets whether the endpoints are registered with Amazon Pinpoint when they are imported."
},
"RoleArn" : {
"shape" : "__string",
"documentation" : "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."
},
"S3Url" : {
"shape" : "__string",
"documentation" : "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."
},
"SegmentId" : {
"shape" : "__string",
"documentation" : "The ID of the segment to update if the import job is meant to update an existing segment."
},
"SegmentName" : {
"shape" : "__string",
"documentation" : "A custom name for the segment created by the import job. Use if DefineSegment is true."
}
}
},
"ImportJobResponse" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"documentation" : "The unique ID of the application to which the import job applies."
},
"CompletedPieces" : {
"shape" : "__integer",
"documentation" : "The number of pieces that have successfully imported as of the time of the request."
},
"CompletionDate" : {
"shape" : "__string",
"documentation" : "The date the import job completed in ISO 8601 format."
},
"CreationDate" : {
"shape" : "__string",
"documentation" : "The date the import job was created in ISO 8601 format."
},
"Definition" : {
"shape" : "ImportJobResource",
"documentation" : "The import job settings."
},
"FailedPieces" : {
"shape" : "__integer",
"documentation" : "The number of pieces that have failed to import as of the time of the request."
},
"Failures" : {
"shape" : "ListOf__string",
"documentation" : "Provides up to 100 of the first failed entries for the job, if any exist."
},
"Id" : {
"shape" : "__string",
"documentation" : "The unique ID of the import job."
},
"JobStatus" : {
"shape" : "JobStatus",
"documentation" : "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."
},
"TotalFailures" : {
"shape" : "__integer",
"documentation" : "The number of endpoints that failed to import; for example, because of syntax errors."
},
"TotalPieces" : {
"shape" : "__integer",
"documentation" : "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."
},
"TotalProcessed" : {
"shape" : "__integer",
"documentation" : "The number of endpoints that were processed by the import job."
},
"Type" : {
"shape" : "__string",
"documentation" : "The job type. Will be Import."
}
}
},
"ImportJobsResponse" : {
"type" : "structure",
"members" : {
"Item" : {
"shape" : "ListOfImportJobResponse",
"documentation" : "A list of import jobs for the application."
},
"NextToken" : {
"shape" : "__string",
"documentation" : "The string that you use in a subsequent request to get the next page of results in a paginated response."
}
}
},
"InternalServerErrorException" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string"
}
},
"exception" : true,
"error" : {
"httpStatusCode" : 500
}
},
"JobStatus" : {
"type" : "string",
"enum" : [ "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED" ]
},
"ListOfActivityResponse" : {
"type" : "list",
"member" : {
"shape" : "ActivityResponse"
}
},
"ListOfCampaignResponse" : {
"type" : "list",
"member" : {
"shape" : "CampaignResponse"
}
},
"ListOfEndpointBatchItem" : {
"type" : "list",
"member" : {
"shape" : "EndpointBatchItem"
}
},
"ListOfImportJobResponse" : {
"type" : "list",
"member" : {
"shape" : "ImportJobResponse"
}
},
"ListOfSegmentResponse" : {
"type" : "list",
"member" : {
"shape" : "SegmentResponse"
}
},
"ListOfTreatmentResource" : {
"type" : "list",
"member" : {
"shape" : "TreatmentResource"
}
},
"ListOfWriteTreatmentResource" : {
"type" : "list",
"member" : {
"shape" : "WriteTreatmentResource"
}
},
"ListOf__string" : {
"type" : "list",
"member" : {
"shape" : "__string"
}
},
"MapOfAttributeDimension" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "AttributeDimension"
}
},
"MapOfListOf__string" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "ListOf__string"
}
},
"MapOf__double" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "__double"
}
},
"Message" : {
"type" : "structure",
"members" : {
"Action" : {
"shape" : "Action",
"documentation" : "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."
},
"Body" : {
"shape" : "__string",
"documentation" : "The message body. Can include up to 140 characters."
},
"ImageIconUrl" : {
"shape" : "__string",
"documentation" : "The URL that points to the icon image for the push notification icon, for example, the app icon."
},
"ImageUrl" : {
"shape" : "__string",
"documentation" : "The URL that points to an image used in the push notification."
},
"JsonBody" : {
"shape" : "__string",
"documentation" : "The JSON payload used for a silent push."
},
"MediaUrl" : {
"shape" : "__string",
"documentation" : "The URL that points to the media resource, for example a .mp4 or .gif file."
},
"SilentPush" : {
"shape" : "__boolean",
"documentation" : "Indicates if the message should display on the users device.\n\nSilent pushes can be used for Remote Configuration and Phone Home use cases. "
},
"Title" : {
"shape" : "__string",
"documentation" : "The message title that displays above the message on the user's device."
},
"Url" : {
"shape" : "__string",
"documentation" : "The URL to open in the user's mobile browser. Used if the value for Action is URL."
}
}
},
"MessageBody" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string"
},
"RequestID" : {
"shape" : "__string"
}
}
},
"MessageConfiguration" : {
"type" : "structure",
"members" : {
"APNSMessage" : {
"shape" : "Message",
"documentation" : "The message that the campaign delivers to APNS channels. Overrides the default message."
},
"DefaultMessage" : {
"shape" : "Message",
"documentation" : "The default message for all channels."
},
"GCMMessage" : {
"shape" : "Message",
"documentation" : "The message that the campaign delivers to GCM channels. Overrides the default message."
}
}
},
"MethodNotAllowedException" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string"
}
},
"exception" : true,
"error" : {
"httpStatusCode" : 405
}
},
"NotFoundException" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string"
}
},
"exception" : true,
"error" : {
"httpStatusCode" : 404
}
},
"QuietTime" : {
"type" : "structure",
"members" : {
"End" : {
"shape" : "__string",
"documentation" : "The default end time for quiet time in ISO 8601 format."
},
"Start" : {
"shape" : "__string",
"documentation" : "The default start time for quiet time in ISO 8601 format."
}
}
},
"RecencyDimension" : {
"type" : "structure",
"members" : {
"Duration" : {
"shape" : "Duration",
"documentation" : "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"
},
"RecencyType" : {
"shape" : "RecencyType",
"documentation" : "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."
}
}
},
"RecencyType" : {
"type" : "string",
"enum" : [ "ACTIVE", "INACTIVE" ]
},
"Schedule" : {
"type" : "structure",
"members" : {
"EndTime" : {
"shape" : "__string",
"documentation" : "The scheduled time that the campaign ends in ISO 8601 format."
},
"Frequency" : {
"shape" : "Frequency",
"documentation" : "How often the campaign delivers messages.\n\nValid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY"
},
"IsLocalTime" : {
"shape" : "__boolean",
"documentation" : "Indicates whether the campaign schedule takes effect according to each user's local time."
},
"QuietTime" : {
"shape" : "QuietTime",
"documentation" : "The time during which the campaign sends no messages."
},
"StartTime" : {
"shape" : "__string",
"documentation" : "The scheduled time that the campaign begins in ISO 8601 format."
},
"Timezone" : {
"shape" : "__string",
"documentation" : "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"
}
}
},
"SegmentBehaviors" : {
"type" : "structure",
"members" : {
"Recency" : {
"shape" : "RecencyDimension",
"documentation" : "The recency of use."
}
}
},
"SegmentDemographics" : {
"type" : "structure",
"members" : {
"AppVersion" : {
"shape" : "SetDimension",
"documentation" : "The app version criteria for the segment."
},
"DeviceType" : {
"shape" : "SetDimension",
"documentation" : "The device type criteria for the segment."
},
"Make" : {
"shape" : "SetDimension",
"documentation" : "The device make criteria for the segment."
},
"Model" : {
"shape" : "SetDimension",
"documentation" : "The device model criteria for the segment."
},
"Platform" : {
"shape" : "SetDimension",
"documentation" : "The device platform criteria for the segment."
}
}
},
"SegmentDimensions" : {
"type" : "structure",
"members" : {
"Attributes" : {
"shape" : "MapOfAttributeDimension",
"documentation" : "Custom segment attributes."
},
"Behavior" : {
"shape" : "SegmentBehaviors",
"documentation" : "The segment behaviors attributes."
},
"Demographic" : {
"shape" : "SegmentDemographics",
"documentation" : "The segment demographics attributes."
},
"Location" : {
"shape" : "SegmentLocation",
"documentation" : "The segment location attributes.\n"
}
}
},
"SegmentImportResource" : {
"type" : "structure",
"members" : {
"ExternalId" : {
"shape" : "__string",
"documentation" : "A unique, custom ID assigned to the IAM role that restricts who can assume the role."
},
"Format" : {
"shape" : "Format",
"documentation" : "The format of the endpoint files that were imported to create this segment.\nValid values: CSV, JSON"
},
"RoleArn" : {
"shape" : "__string",
"documentation" : "The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3."
},
"S3Url" : {
"shape" : "__string",
"documentation" : "A URL that points to the Amazon S3 location from which the endpoints for this segment were imported."
},
"Size" : {
"shape" : "__integer",
"documentation" : "The number of endpoints that were successfully imported to create this segment."
}
}
},
"SegmentLocation" : {
"type" : "structure",
"members" : {
"Country" : {
"shape" : "SetDimension",
"documentation" : "The country filter according to ISO 3166-1 Alpha-2 codes."
}
}
},
"SegmentResponse" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"documentation" : "The ID of the application to which the segment applies."
},
"CreationDate" : {
"shape" : "__string",
"documentation" : "The date the segment was created in ISO 8601 format."
},
"Dimensions" : {
"shape" : "SegmentDimensions",
"documentation" : "The segment dimensions attributes."
},
"Id" : {
"shape" : "__string",
"documentation" : "The unique segment ID."
},
"ImportDefinition" : {
"shape" : "SegmentImportResource",
"documentation" : "The import job settings."
},
"LastModifiedDate" : {
"shape" : "__string",
"documentation" : "The date the segment was last updated in ISO 8601 format."
},
"Name" : {
"shape" : "__string",
"documentation" : "The name of segment"
},
"SegmentType" : {
"shape" : "SegmentType",
"documentation" : "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."
},
"Version" : {
"shape" : "__integer",
"documentation" : "The segment version number."
}
}
},
"SegmentType" : {
"type" : "string",
"enum" : [ "DIMENSIONAL", "IMPORT" ]
},
"SegmentsResponse" : {
"type" : "structure",
"members" : {
"Item" : {
"shape" : "ListOfSegmentResponse",
"documentation" : "The list of segments."
},
"NextToken" : {
"shape" : "__string",
"documentation" : "An identifier used to retrieve the next page of results. The token is null if no additional pages exist."
}
}
},
"SetDimension" : {
"type" : "structure",
"members" : {
"DimensionType" : {
"shape" : "DimensionType",
"documentation" : "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."
},
"Values" : {
"shape" : "ListOf__string",
"documentation" : "The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type."
}
}
},
"TooManyRequestsException" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string"
}
},
"exception" : true,
"error" : {
"httpStatusCode" : 429
}
},
"TreatmentResource" : {
"type" : "structure",
"members" : {
"Id" : {
"shape" : "__string",
"documentation" : "The unique treatment ID."
},
"MessageConfiguration" : {
"shape" : "MessageConfiguration",
"documentation" : "The message configuration settings."
},
"Schedule" : {
"shape" : "Schedule",
"documentation" : "The campaign schedule."
},
"SizePercent" : {
"shape" : "__integer",
"documentation" : "The allocated percentage of users for this treatment."
},
"State" : {
"shape" : "CampaignState",
"documentation" : "The treatment status."
},
"TreatmentDescription" : {
"shape" : "__string",
"documentation" : "A custom description for the treatment."
},
"TreatmentName" : {
"shape" : "__string",
"documentation" : "The custom name of a variation of the campaign used for A/B testing."
}
}
},
"UpdateApnsChannelRequest" : {
"type" : "structure",
"members" : {
"APNSChannelRequest" : {
"shape" : "APNSChannelRequest"
},
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
}
},
"required" : [ "ApplicationId", "APNSChannelRequest" ],
"payload" : "APNSChannelRequest"
},
"UpdateApnsChannelResponse" : {
"type" : "structure",
"members" : {
"APNSChannelResponse" : {
"shape" : "APNSChannelResponse"
}
},
"required" : [ "APNSChannelResponse" ],
"payload" : "APNSChannelResponse"
},
"UpdateApplicationSettingsRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"WriteApplicationSettingsRequest" : {
"shape" : "WriteApplicationSettingsRequest"
}
},
"required" : [ "ApplicationId", "WriteApplicationSettingsRequest" ],
"payload" : "WriteApplicationSettingsRequest"
},
"UpdateApplicationSettingsResponse" : {
"type" : "structure",
"members" : {
"ApplicationSettingsResource" : {
"shape" : "ApplicationSettingsResource"
}
},
"required" : [ "ApplicationSettingsResource" ],
"payload" : "ApplicationSettingsResource"
},
"UpdateCampaignRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"CampaignId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "campaign-id"
},
"WriteCampaignRequest" : {
"shape" : "WriteCampaignRequest"
}
},
"required" : [ "CampaignId", "ApplicationId", "WriteCampaignRequest" ],
"payload" : "WriteCampaignRequest"
},
"UpdateCampaignResponse" : {
"type" : "structure",
"members" : {
"CampaignResponse" : {
"shape" : "CampaignResponse"
}
},
"required" : [ "CampaignResponse" ],
"payload" : "CampaignResponse"
},
"UpdateEndpointRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"EndpointId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "endpoint-id"
},
"EndpointRequest" : {
"shape" : "EndpointRequest"
}
},
"required" : [ "ApplicationId", "EndpointId", "EndpointRequest" ],
"payload" : "EndpointRequest"
},
"UpdateEndpointResponse" : {
"type" : "structure",
"members" : {
"MessageBody" : {
"shape" : "MessageBody"
}
},
"required" : [ "MessageBody" ],
"payload" : "MessageBody"
},
"UpdateEndpointsBatchRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"EndpointBatchRequest" : {
"shape" : "EndpointBatchRequest"
}
},
"required" : [ "ApplicationId", "EndpointBatchRequest" ],
"payload" : "EndpointBatchRequest"
},
"UpdateEndpointsBatchResponse" : {
"type" : "structure",
"members" : {
"MessageBody" : {
"shape" : "MessageBody"
}
},
"required" : [ "MessageBody" ],
"payload" : "MessageBody"
},
"UpdateGcmChannelRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"GCMChannelRequest" : {
"shape" : "GCMChannelRequest"
}
},
"required" : [ "ApplicationId", "GCMChannelRequest" ],
"payload" : "GCMChannelRequest"
},
"UpdateGcmChannelResponse" : {
"type" : "structure",
"members" : {
"GCMChannelResponse" : {
"shape" : "GCMChannelResponse"
}
},
"required" : [ "GCMChannelResponse" ],
"payload" : "GCMChannelResponse"
},
"UpdateSegmentRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
},
"SegmentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "segment-id"
},
"WriteSegmentRequest" : {
"shape" : "WriteSegmentRequest"
}
},
"required" : [ "SegmentId", "ApplicationId", "WriteSegmentRequest" ],
"payload" : "WriteSegmentRequest"
},
"UpdateSegmentResponse" : {
"type" : "structure",
"members" : {
"SegmentResponse" : {
"shape" : "SegmentResponse"
}
},
"required" : [ "SegmentResponse" ],
"payload" : "SegmentResponse"
},
"WriteApplicationSettingsRequest" : {
"type" : "structure",
"members" : {
"Limits" : {
"shape" : "CampaignLimits",
"documentation" : "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."
},
"QuietTime" : {
"shape" : "QuietTime",
"documentation" : "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."
}
}
},
"WriteCampaignRequest" : {
"type" : "structure",
"members" : {
"AdditionalTreatments" : {
"shape" : "ListOfWriteTreatmentResource",
"documentation" : "Treatments that are defined in addition to the default treatment."
},
"Description" : {
"shape" : "__string",
"documentation" : "A description of the campaign."
},
"HoldoutPercent" : {
"shape" : "__integer",
"documentation" : "The allocated percentage of end users who will not receive messages from this campaign."
},
"IsPaused" : {
"shape" : "__boolean",
"documentation" : "Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false."
},
"Limits" : {
"shape" : "CampaignLimits",
"documentation" : "The campaign limits settings."
},
"MessageConfiguration" : {
"shape" : "MessageConfiguration",
"documentation" : "The message configuration settings."
},
"Name" : {
"shape" : "__string",
"documentation" : "The custom name of the campaign."
},
"Schedule" : {
"shape" : "Schedule",
"documentation" : "The campaign schedule."
},
"SegmentId" : {
"shape" : "__string",
"documentation" : "The ID of the segment to which the campaign sends messages."
},
"SegmentVersion" : {
"shape" : "__integer",
"documentation" : "The version of the segment to which the campaign sends messages."
},
"TreatmentDescription" : {
"shape" : "__string",
"documentation" : "A custom description for the treatment."
},
"TreatmentName" : {
"shape" : "__string",
"documentation" : "The custom name of a variation of the campaign used for A/B testing."
}
}
},
"WriteSegmentRequest" : {
"type" : "structure",
"members" : {
"Dimensions" : {
"shape" : "SegmentDimensions",
"documentation" : "The segment dimensions attributes."
},
"Name" : {
"shape" : "__string",
"documentation" : "The name of segment"
}
}
},
"WriteTreatmentResource" : {
"type" : "structure",
"members" : {
"MessageConfiguration" : {
"shape" : "MessageConfiguration",
"documentation" : "The message configuration settings."
},
"Schedule" : {
"shape" : "Schedule",
"documentation" : "The campaign schedule."
},
"SizePercent" : {
"shape" : "__integer",
"documentation" : "The allocated percentage of users for this treatment."
},
"TreatmentDescription" : {
"shape" : "__string",
"documentation" : "A custom description for the treatment."
},
"TreatmentName" : {
"shape" : "__string",
"documentation" : "The custom name of a variation of the campaign used for A/B testing."
}
}
},
"__boolean" : {
"type" : "boolean"
},
"__double" : {
"type" : "double"
},
"__integer" : {
"type" : "integer"
},
"__string" : {
"type" : "string"
}
}
}
Reference in a new issue View git blame Copy permalink