[ aws . pinpoint ]

get-channels

Description

Retrieves information about the history and status of each channel for an application.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-channels
--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

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To retrieves information about the history and status of each channel for an application

The following get-channels example retrieves information about the history and status of each channel for an application.

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

Output:

{
    "ChannelsResponse": {
        "Channels": {
            "GCM": {
                "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
                "CreationDate": "2019-10-08T18:28:23.182Z",
                "Enabled": true,
                "HasCredential": true,
                "Id": "gcm",
                "IsArchived": false,
                "LastModifiedDate": "2019-10-08T18:28:23.182Z",
                "Version": 1
            },
            "SMS": {
                "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
                "CreationDate": "2019-10-08T18:39:18.511Z",
                "Enabled": true,
                "Id": "sms",
                "IsArchived": false,
                "LastModifiedDate": "2019-10-08T18:39:18.511Z",
                "Version": 1
            },
            "EMAIL": {
                "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
                "CreationDate": "2019-10-08T18:27:23.990Z",
                "Enabled": true,
                "Id": "email",
                "IsArchived": false,
                "LastModifiedDate": "2019-10-08T18:27:23.990Z",
                "Version": 1
            },
            "IN_APP": {
                "Enabled": true,
                "IsArchived": false,
                "Version": 0
            }
        }
    }
}

Output

ChannelsResponse -> (structure)

Provides information about the general settings and status of all channels for an application, including channels that aren’t enabled for the application.

Channels -> (map)

A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.

key -> (string)

value -> (structure)

Provides information about the general settings and status of a channel for an application.

ApplicationId -> (string)

The unique identifier for the application.

CreationDate -> (string)

The date and time, in ISO 8601 format, when the channel was enabled.

Enabled -> (boolean)

Specifies whether the 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 channel. This property is retained only for backward compatibility.

IsArchived -> (boolean)

Specifies whether the channel is archived.

LastModifiedBy -> (string)

The user who last modified the channel.

LastModifiedDate -> (string)

The date and time, in ISO 8601 format, when the channel was last modified.

Version -> (integer)

The current version of the channel.