Table Of Contents

Feedback

User Guide

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

[ aws . pinpoint ]

get-voice-channel

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-voice-channel
--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

VoiceChannelResponse -> (structure)

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

ApplicationId -> (string)

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

CreationDate -> (string)

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

Enabled -> (boolean)

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

IsArchived -> (boolean)

Specifies whether the voice channel is archived.

LastModifiedBy -> (string)

The user who last modified the voice channel.

LastModifiedDate -> (string)

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

Platform -> (string)

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

Version -> (integer)

The current version of the voice channel.