App
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.
You can use the App resource to retrieve information about or delete an
existing application. To create a new application, use the Apps resource and send a POST request to the /apps
URI.
URI
/v1/apps/application-id
HTTP methods
GET
Operation ID: GetApp
Retrieves information about an application.
| Name | Type | Required | Description |
|---|---|---|---|
application-id | String | True | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| Name | Type | Required | Description |
|---|---|---|---|
accept | String | False | Indicates which content types, expressed as MIME types, the client understands. |
| Status code | Response model | Description |
|---|---|---|
200 | ApplicationResponse | 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). |
DELETE
Operation ID: DeleteApp
Deletes an application.
| Name | Type | Required | Description |
|---|---|---|---|
application-id | String | True | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| Name | Type | Required | Description |
|---|---|---|---|
accept | String | False | Indicates which content types, expressed as MIME types, the client understands. |
| Status code | Response model | Description |
|---|---|---|
200 | ApplicationResponse | 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). |
OPTIONS
Retrieves information about the communication requirements and options that are available for the App resource.
| Name | Type | Required | Description |
|---|---|---|---|
application-id | String | True | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
| Status code | Response model | Description |
|---|---|---|
200 | None | The request succeeded. |
Schemas
Response bodies
{
"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. |
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:
GetApp
DeleteApp
