Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Parameter types

This section describes some of the common parameter types and the typical required format. If you're having trouble formatting an option or argument for a specific command, check the help by entering --help after the command name. The help for each command describes its function and options accepted.

String

String parameters can contain letters, numbers,and white space. Strings that contain white space must be surrounded by quotation marks. Strings can be surrounded by single quotation marks, double quotation marks, or without them. We recommend that you don't use symbols because it can cause unexpected results.

String

One or more strings separated by comma and surrounded by quotation marks. The following example shows a list of --session-ids.

dcvsm describe-sessions --session-ids "session123,session456"

Boolean

Binary flag that turns an option on or off. For example, --debug describe-sessions has a Boolean --debug option that, when specified, calls the API enabling the debugging.

dcvsm --debug describe-sessions

If you don’t specify explicitly a boolean option, it’s set to FALSE by default.

Integer

An unsigned, whole number.

dcvsm describe-sessions --max-results 2