• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateAdmChannel
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteAdmChannel
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
APNs Channel
A channel is a type of platform that you can deliver messages to. You can use the APNs channel to send push notification messages to the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send notification messages to APNs, you must enable the APNs channel for an Amazon Pinpoint application.
The APNs Channel resource represents the status and authentication settings of the APNs channel for a specific application. You can use this resource to enable, retrieve information about, update, or disable (delete) the APNs channel for an application.
URI
/v1/apps/application-id/channels/apns
HTTP methods
HTTP methods
GET
Operation ID: GetApnsChannel
Retrieves information about the status and settings of the APNs 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 APNSChannelResponse (p. 29)The request succeeded.
400 MessageBody (p. 29) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 29) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 29) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 29) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 29) 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. 29) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 29) The request failed due to
an unknown internal server error, exception, or failure (InternalServerErrorException).
PUT
Operation ID: UpdateApnsChannel
Enables the APNs channel for an application or updates the status and settings of the APNs 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 APNSChannelResponse (p. 29)The request succeeded.
400 MessageBody (p. 29) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 29) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 29) The request failed because the
specified resource was not found (NotFoundException).
HTTP methods
Status code Response model Description
405 MessageBody (p. 29) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 29) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 29) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 29) The request failed due to
an unknown internal server error, exception, or failure (InternalServerErrorException).
DELETE
Operation ID: DeleteApnsChannel
Disables the APNs 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 APNSChannelResponse (p. 29)The request succeeded.
400 MessageBody (p. 29) The request contains a syntax
error (BadRequestException).
HTTP methods
Status code Response model Description
403 MessageBody (p. 29) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 29) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 29) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 29) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 29) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 29) 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 APNs 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
{ "Certificate": "string", "PrivateKey": "string", "Enabled": boolean, "TokenKeyId": "string", "TeamId": "string", "TokenKey": "string", "BundleId": "string",
"DefaultAuthenticationMethod": "string"
}
Response bodies
APNSChannelResponse schema
{ "ApplicationId": "string", "IsArchived": boolean, "Version": integer, "CreationDate": "string", "LastModifiedDate": "string", "LastModifiedBy": "string", "Id": "string",
"Enabled": boolean, "HasCredential": boolean, "Platform": "string", "HasTokenKey": boolean,
"DefaultAuthenticationMethod": "string"
}
MessageBody schema
{
"RequestID": "string", "Message": "string"
}
Properties
APNSChannelRequest
Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.