Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . pinpoint ]



Use to update the APNs channel for an app.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--apns-channel-request <value>
--application-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--apns-channel-request (structure) Apple Push Notification Service channel definition.

Shorthand Syntax:


JSON Syntax:

  "BundleId": "string",
  "Certificate": "string",
  "DefaultAuthenticationMethod": "string",
  "Enabled": true|false,
  "PrivateKey": "string",
  "TeamId": "string",
  "TokenKey": "string",
  "TokenKeyId": "string"

--application-id (string) The unique ID of your Amazon Pinpoint application.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


APNSChannelResponse -> (structure)

Apple Distribution Push Notification Service channel definition.

ApplicationId -> (string)

The ID of the application that the channel applies to.

CreationDate -> (string)

The date and time when this channel was created.

DefaultAuthenticationMethod -> (string)

The default authentication method used for APNs.

Enabled -> (boolean)

If the channel is enabled for sending messages.

HasCredential -> (boolean)

Not used. Retained for backwards compatibility.

HasTokenKey -> (boolean)

Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.

Id -> (string)

(Deprecated) An identifier for the channel. Retained for backwards compatibility.

IsArchived -> (boolean)

Indicates whether or not the channel is archived.

LastModifiedBy -> (string)

The user who last updated this channel.

LastModifiedDate -> (string)

The date and time when this channel was last modified.

Platform -> (string)

The platform type. For this channel, the value is always "ADM."

Version -> (integer)

The channel version.