Amazon Pinpoint
REST API Reference

Apps

An app represents an Amazon Pinpoint application, also referred to as a project, in which you define an audience and you engage this audience with tailored messages. For example, you can use an application to send push notifications to users of your iOS or Android app, send email to newsletter subscribers, or send SMS messages to your customers' mobile phones.

After you create an application, you can define your audience by registering endpoints and defining segments. To engage your audience, define campaigns or write direct messages, and send your messages by using any supported channel, including channels for mobile push notifications, email, SMS, and voice. You can then monitor application analytics by creating an event stream, which streams data for message deliveries and events that your app reports to Amazon Pinpoint. Analytics are also provided on the Amazon Pinpoint console.

You can use the Apps resource to create a new application or retrieve information about all of your existing applications. To delete an application, use the App resource and send a DELETE request to the /apps/application-id URI.

URI

/v1/apps

HTTP Methods

GET

Operation ID: GetApps

Retrieves information about all of your applications.

Header Parameters

Name Type Required Description
accept String False

Indicates which content types, expressed as MIME types, the client understands.

Query Parameters

Name Type Required Description
token String False

The NextToken string that specifies which page of results to return in a paginated response.

page-size String False

The maximum number of items to include on each page in a paginated response.

Responses

Status Code Response Model Description
200 ApplicationsResponse

The request succeeded.

400 MessageBody

The request contains a syntax error (BadRequestException).

403 MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

404 MessageBody

The request failed because the specified resource was not found (NotFoundException).

405 MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

429 MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500 MessageBody

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

POST

Operation ID: CreateApp

Creates an application.

Header Parameters

Name Type Required Description
accept String False

Indicates which content types, expressed as MIME types, the client understands.

Responses

Status Code Response Model Description
201 ApplicationResponse

The request succeeded and the specified resource was created.

400 MessageBody

The request contains a syntax error (BadRequestException).

403 MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

404 MessageBody

The request failed because the specified resource was not found (NotFoundException).

405 MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

429 MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500 MessageBody

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

OPTIONS

Retrieves information about the communication requirements and options that are available for the Apps resource.

Responses

Status Code Response Model Description
200 None

The request succeeded.

Schemas

Request Bodies

Example POST

{ "Name": "string", "tags": { } }

Response Bodies

Example ApplicationsResponse

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

Example ApplicationResponse

{ "Name": "string", "Id": "string", "Arn": "string", "tags": { } }

Example MessageBody

{ "RequestID": "string", "Message": "string" }

Properties

ApplicationResponse

Property Type Required Description
Name

string

True

The display name of the application.

Id

string

True

The unique identifier for the application.

Arn

string

True

The Amazon Resource Name (ARN) of the application.

tags

object

False

A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

ApplicationsResponse

Property Type Required Description
NextToken

string

False

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Item

Array of type ApplicationResponse

False

An array of responses, one for each application that was returned.

CreateApplicationRequest

Property Type Required Description
Name

string

True

The display name of the application. This name appears on the Amazon Pinpoint console.

tags

object

False

A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.

MessageBody

Provides information about an API request or response.

Property Type Required Description
RequestID

string

False

The unique identifier for the request or response.

Message

string

False

The message that's returned from the API.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetApps

CreateApp