Amazon Pinpoint
REST API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

ADM Channel

A channel is a type of platform that you can deliver messages to. You can use the ADM channel to send push notifications through the Amazon Device Messaging (ADM) service to apps that are running on Amazon devices, such as Kindle Fire tablets. Before you can use Amazon Pinpoint to send messages to Amazon devices, you must enable the ADM channel for an Amazon Pinpoint application.

The ADM Channel resource represents the status and authentication settings of the ADM channel for a specific application. You can use this resource to enable, retrieve information about, update, or disable (delete) the ADM channel for an application.

URI

/v1/apps/application-id/channels/adm

HTTP Methods

GET

Operation ID: GetAdmChannel

Retrieves information about the status and settings of the ADM channel for an application.

Path Parameters

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.

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 ADMChannelResponse

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).

PUT

Operation ID: UpdateAdmChannel

Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.

Path Parameters

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.

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 ADMChannelResponse

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: DeleteAdmChannel

Disables the ADM channel for an application and deletes any existing settings for the channel.

Path Parameters

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.

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 ADMChannelResponse

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 ADM Channel resource.

Responses

Status Code Response Model Description
200 None

The request succeeded.

Schemas

Request Bodies

Example PUT

{ "ClientId": "string", "ClientSecret": "string", "Enabled": boolean }

Response Bodies

Example ADMChannelResponse

{ "ApplicationId": "string", "IsArchived": boolean, "Version": integer, "CreationDate": "string", "LastModifiedDate": "string", "LastModifiedBy": "string", "Id": "string", "Enabled": boolean, "HasCredential": boolean, "Platform": "string" }

Example MessageBody

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

Properties

ADMChannelRequest

Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.

Property Type Required Description
ClientId

string

True

The Client ID that you received from Amazon to send messages by using ADM.

ClientSecret

string

True

The Client Secret that you received from Amazon to send messages by using ADM.

Enabled

boolean

False

Specifies whether to enable the ADM channel for the application.

ADMChannelResponse

Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.

Property Type Required Description
ApplicationId

string

False

The unique identifier for the application that the ADM channel applies to.

IsArchived

boolean

False

Specifies whether the ADM channel is archived.

Version

integer

False

The current version of the ADM channel.

CreationDate

string

False

The date and time when the ADM channel was enabled.

LastModifiedDate

string

False

The date and time when the ADM channel was last modified.

LastModifiedBy

string

False

The user who last modified the ADM channel.

Id

string

False

(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.

Enabled

boolean

False

Specifies whether the ADM channel is enabled for the application.

HasCredential

boolean

False

(Not used) This property is retained only for backward compatibility.

Platform

string

True

The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.

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:

GetAdmChannel

UpdateAdmChannel

DeleteAdmChannel