[ aws . pinpoint ]

get-gcm-channel

Description

Retrieves information about the status and settings of the GCM channel for an application.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-gcm-channel
--application-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--application-id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Examples

To retrieve information about the status and settings of the GCM channel for an application

The following get-gcm-channel example retrieves information about the status and settings of the GCM channel for an application.

aws pinpoint get-gcm-channel \
    --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \
    --region us-east-1

Output:

{
    "GCMChannelResponse": {
        "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
        "CreationDate": "2019-10-08T18:28:23.182Z",
        "Enabled": true,
        "HasCredential": true,
        "Id": "gcm",
        "IsArchived": false,
        "LastModifiedDate": "2019-10-08T18:28:23.182Z",
        "Platform": "GCM",
        "Version": 1
    }
}

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.

Enabled -> (boolean)

Specifies whether the GCM channel is enabled for the application.

HasCredential -> (boolean)

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

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.