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
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 (p. 21)The request succeeded.
400 MessageBody (p. 21) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 21) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 21) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 21) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 21) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
HTTP methods
Status code Response model Description
429 MessageBody (p. 21) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 21) 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 (p. 21)The request succeeded.
400 MessageBody (p. 21) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 21) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 21) The request failed because the
specified resource was not found (NotFoundException).
HTTP methods
Status code Response model Description
405 MessageBody (p. 21) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 21) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 21) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 21) 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 (p. 21)The request succeeded.
400 MessageBody (p. 21) The request contains a syntax
error (BadRequestException).
HTTP methods
Status code Response model Description
403 MessageBody (p. 21) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 21) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 21) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 21) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 21) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 21) 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.
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.
Responses
Status code Response model Description
200 None The request succeeded.
Schemas
Schemas
Request bodies
PUT schema
{ "ClientId": "string", "ClientSecret": "string", "Enabled": boolean }
Response bodies
ADMChannelResponse schema
{
"ApplicationId": "string", "IsArchived": boolean, "Version": integer, "CreationDate": "string", "LastModifiedDate": "string", "LastModifiedBy": "string", "Id": "string",
"Enabled": boolean, "HasCredential": boolean, "Platform": "string"
}
MessageBody schema
{ "RequestID": "string", "Message": "string"
}
Properties
ADMChannelRequest
Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.
ClientId
The Client ID that you received from Amazon to send messages by using ADM.
Type: string Required: True
ClientSecret
The Client Secret that you received from Amazon to send messages by using ADM.
Type: string
Properties
Required: True
Enabled
Specifies whether to enable the ADM channel for the application.
Type: boolean Required: False
ADMChannelResponse
Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
ApplicationId
The unique identifier for the application that the ADM channel applies to.
Type: string Required: False
IsArchived
Specifies whether the ADM channel is archived.
Type: boolean Required: False
Version
The current version of the ADM channel.
Type: integer Required: False
CreationDate
The date and time when the ADM channel was enabled.
Type: string Required: False