Table Of Contents

Feedback

User Guide

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

[ aws . pinpoint ]

update-gcm-channel

Description

Use to update the GCM channel for an app.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--application-id (string)

--gcm-channel-request (structure) Google Cloud Messaging credentials

Shorthand Syntax:

ApiKey=string,Enabled=boolean

JSON Syntax:

{
  "ApiKey": "string",
  "Enabled": true|false
}

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

See 'aws help' for descriptions of global parameters.

Output

GCMChannelResponse -> (structure)

Google Cloud Messaging channel definition

ApplicationId -> (string)

The ID of the application to which the channel applies.

CreationDate -> (string)

When was this segment created

Credential -> (string)

The GCM API key from Google.

Enabled -> (boolean)

If the channel is enabled for sending messages.

HasCredential -> (boolean)

If the channel is registered with a credential for authentication.

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 GCM

Version -> (integer)

Version of channel