Table Of Contents

Feedback

User Guide

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

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 ]

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 <value>]
[--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 (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.

See 'aws help' for descriptions of global parameters.

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.