Amazon Pinpoint
REST API Reference

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.

Path Parameters

Name Type Required Description
application-id String True

The unique identifier for the 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
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).

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.

Path Parameters

Name Type Required Description
application-id String True

The unique identifier for the 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
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).

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.

Responses

Status Code Response Model Description
200 None

The request succeeded.

Schemas

Response Bodies

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.

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:

GetApp

DeleteApp