Table Of Contents

Feedback

User Guide

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

[ aws . pinpoint ]

update-apns-channel

Description

Use to update the APNs channel for an app.

See also: AWS API Documentation

Synopsis

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

Options

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

Shorthand Syntax:

BundleId=string,Certificate=string,DefaultAuthenticationMethod=string,Enabled=boolean,PrivateKey=string,TeamId=string,TokenKey=string,TokenKeyId=string

JSON Syntax:

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

--application-id (string)

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

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

Output

APNSChannelResponse -> (structure)

Apple Distribution Push Notification Service channel definition.

ApplicationId -> (string)

The ID of the application to which the channel applies.

CreationDate -> (string)

When was this segment created

Enabled -> (boolean)

If the channel is enabled for sending messages.

Id -> (string)

Channel ID. Not used. Present only for backwards compatibility.

IsArchived -> (boolean)

Is this channel archived

LastModifiedBy -> (string)

Who last updated this entry

LastModifiedDate -> (string)

Last date this was updated

Platform -> (string)

The platform type. Will be APNS.

Version -> (integer)

Version of channel