AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . pinpoint ]

update-gcm-channel

Description

Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

See also: AWS API Documentation

Synopsis

  update-gcm-channel
--application-id <value>
--gcm-channel-request <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--application-id (string)

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

--gcm-channel-request (structure)

Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

ApiKey -> (string)

The Web API Key, also referred to as an API_KEY or server key , that you received from Google to communicate with Google services.

DefaultAuthenticationMethod -> (string)

The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".

Enabled -> (boolean)

Specifies whether to enable the GCM channel for the application.

ServiceJson -> (string)

The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. For more information see Migrate from legacy FCM APIs to HTTP v1 .

Shorthand Syntax:

ApiKey=string,DefaultAuthenticationMethod=string,Enabled=boolean,ServiceJson=string

JSON Syntax:

{
  "ApiKey": "string",
  "DefaultAuthenticationMethod": "string",
  "Enabled": true|false,
  "ServiceJson": "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. 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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

GCMChannelResponse -> (structure)

Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

ApplicationId -> (string)

The unique identifier for the application that the GCM channel applies to.

CreationDate -> (string)

The date and time when the GCM channel was enabled.

Credential -> (string)

The Web API Key, also referred to as an API_KEY or server key , that you received from Google to communicate with Google services.

DefaultAuthenticationMethod -> (string)

The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".

Enabled -> (boolean)

Specifies whether the GCM channel is enabled for the application.

HasCredential -> (boolean)

(Not used) This property is retained only for backward compatibility.

HasFcmServiceCredentials -> (boolean)

Returns true if the JSON file provided by Google during registration process was used in the ServiceJson field of the request.

Id -> (string)

(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.

IsArchived -> (boolean)

Specifies whether the GCM channel is archived.

LastModifiedBy -> (string)

The user who last modified the GCM channel.

LastModifiedDate -> (string)

The date and time when the GCM channel was last modified.

Platform -> (string)

The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.

Version -> (integer)

The current version of the GCM channel.