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/ URI.application-id
URI
/v1/apps
HTTP methods
GET
Operation ID: GetApps
Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
| Name | Type | Required | Description |
|---|---|---|---|
accept | String | False | Indicates which content types, expressed as MIME types, the client understands. |
| Name | Type | Required | Description |
|---|---|---|---|
token | String | False | The |
page-size | String | False | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. |
| 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). |
413 | MessageBody | The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException). |
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.
| Name | Type | Required | Description |
|---|---|---|---|
accept | String | False | Indicates which content types, expressed as MIME types, the client understands. |
| 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). |
413 | MessageBody | The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException). |
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.
| Status code | Response model | Description |
|---|---|---|
200 | None | The request succeeded. |
Schemas
Request bodies
Response bodies
{
"NextToken": "string",
"Item": [
{
"Name": "string",
"Id": "string",
"Arn": "string",
"CreationDate": "string",
"tags": {
}
}
]
}{
"Name": "string",
"Id": "string",
"Arn": "string",
"CreationDate": "string",
"tags": {
}
}Properties
ApplicationResponse
Provides information about an application.
| Property | Type | Required | Description |
|---|---|---|---|
Arn | string | True | The Amazon Resource Name (ARN) of the application. |
CreationDate | string | False | The creation date for the application. |
Id | string | True | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
Name | string | True | The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console. |
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
Provides information about all of your applications.
| Property | Type | Required | Description |
|---|---|---|---|
Item | Array of type ApplicationResponse | False | An array of responses, one for each application that was returned. |
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. |
CreateApplicationRequest
Specifies the display name of an application and the tags to associate with the application.
| Property | Type | Required | Description |
|---|---|---|---|
Name | string | True | The display name of the application. This name is displayed as the Project name 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 |
|---|---|---|---|
Message | string | False | The message that's returned from the API. |
RequestID | string | False | The unique identifier for the request or response. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
GetApps
CreateApp
