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 . chime ]

list-meetings

Description

Lists up to 100 active Amazon Chime SDK meetings.

Warning

ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

See also: AWS API Documentation

Synopsis

  list-meetings
[--next-token <value>]
[--max-results <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

--next-token (string)

The token to use to retrieve the next page of results.

--max-results (integer)

The maximum number of results to return in a single call.

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

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

Meetings -> (list)

The Amazon Chime SDK meeting information.

(structure)

A meeting created using the Amazon Chime SDK.

MeetingId -> (string)

The Amazon Chime SDK meeting ID.

ExternalMeetingId -> (string)

The external meeting ID.

MediaPlacement -> (structure)

The media placement for the meeting.

AudioHostUrl -> (string)

The audio host URL.

AudioFallbackUrl -> (string)

The audio fallback URL.

ScreenDataUrl -> (string)

The screen data URL.

Warning

This parameter is is no longer supported and no longer used by the Amazon Chime SDK.

ScreenSharingUrl -> (string)

The screen sharing URL.

Warning

This parameter is is no longer supported and no longer used by the Amazon Chime SDK. .

ScreenViewingUrl -> (string)

The screen viewing URL.

Warning

This parameter is is no longer supported and no longer used by the Amazon Chime SDK.

SignalingUrl -> (string)

The signaling URL.

TurnControlUrl -> (string)

The turn control URL.

Warning

This parameter is is no longer supported and no longer used by the Amazon Chime SDK.

EventIngestionUrl -> (string)

The event ingestion URL to which you send client meeting events.

MediaRegion -> (string)

The Region in which you create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

NextToken -> (string)

The token to use to retrieve the next page of results.