本文档仅适用于 Amazon CLI 版本 1。有关 Amazon CLI 版本 2 的相关文档,请参阅版本 2 用户指南。
通用 Amazon CLI 参数类型
本节介绍一些通用参数类型以及典型的所需格式。
如果您不知道如何设置特定命令的参数格式,请在命令名称后输入 help
来查看帮助。每个子命令的帮助均包括一个选项的名称和描述。该选项的参数类型在括号中列出。有关查看帮助的更多信息,请参阅 使用 Amazon CLI 获取帮助。
字符串
字符串参数可以包含 ASCII
一些字符串参数可接受来自文件的二进制数据。有关示例,请参阅二进制文件。
时间戳
时间戳根据 ISO 8601DateTime
”或“Date
”参数。
$
aws ec2 describe-spot-price-history
--start-time 2014-10-13T19:00:00Z
可接受的格式包括:
-
YYYY
-MM
-DD
Thh
:mm
:ss.sss
TZD (UTC)
,例如,2014-10-01T20:30:00.000Z -
YYYY
-MM
-DD
Thh
:mm
:ss.sss
TZD(带偏移量)
,例如,2014-10-01T12:30:00.000-08:00 -
YYYY
-MM
-DD
,例如,2014-10-01 -
以秒为单位的 Unix 时间,如 1412195400。这有时称为 Unix 纪元时间
,表示自 1970 年 1 月 1 日午夜 (UTC) 以来经历的秒数。
列表
以空格分隔的一个或多个字符串。如果任何字符串项目包含空格,则必须用引号括起该项目。遵循您的终端引用规则以防止出现意外结果
$
aws ec2 describe-spot-price-history
--instance-types m1.xlarge m1.medium
布尔值
打开或关闭某一选项的二进制标志。例如,ec2
describe-spot-price-history
有一个布尔 --dry-run
参数,如果指定该参数,则针对服务验证查询而不实际运行查询。
$
aws ec2 describe-spot-price-history
--dry-run
输出指示命令格式是否正确。此命令还包含一个 --no-dry-run
参数版本,可以用来显式指示命令应正常运行。不过不是必须包含此参数,因为这是默认行为。
整数
无符号整数。
$
aws ec2 describe-spot-price-history
--max-items 5
二进制/Blob(二进制大型对象)
在 Amazon CLI 版本 1 中,要将值传递给具有类型 blob
的参数,必须指定包含二进制数据的本地文件的路径。此路径不应包含任何协议标识符,例如 http://
或 file://
。指定的路径被解释为相对于当前工作目录。例如,适用于 aws s3api put-object
的 --body
参数是一个 blob。
$
aws s3api put-object --bucket my-bucket --key testimage.png
--body /tmp/image.png
映射
使用 JSON 或 CLI 的速记语法指定的一系列密钥值对。以下 JSON 示例使用 map 参数 --key
从名为 my-table 的 Amazon DynamoDB 表中读取项目。此参数在嵌套的 JSON 结构中指定名为 id 且数值为 1 的主键。
要在命令行中使用更高级的 JSON,请考虑使用 jq
等命令行 JSON 处理器来创建 JSON 字符串。有关 jq
的更多信息,请参阅 GitHub 上的 jq 存储库
$
aws dynamodb get-item --table-name my-table --key '{"id": {"N":"1"}}'
{ "Item": { "name": { "S": "John" }, "id": { "N": "1" } } }
文档
速记语法与文档类型不兼容。
文档类型用于发送数据,无需在字符串中嵌入 JSON。文档类型使服务能够提供任意架构,以便您使用更灵活的数据类型。
这使得无需对值转义,即可发送 JSON 数据。例如,不使用以下转义的 JSON 输入:
{"document": "{\"key\":true}"}
您可以使用以下文档类型:
{"document": {"key": true}}
文档类型的有效值
由于文档类型本身多种多样,因此存在多个有效值类型。有效值包括:
- 字符串
-
--option
'"value"'
- 数字
-
--option
123
--option
123.456
- 布尔值
-
--option
true
- Null
-
--option
null
- 数组
-
--option
'["value1", "value2", "value3"]'
--option
'["value", 1, true, null, ["key1", 2.34], {"key2": "value2"}]'
- 对象
-
--option
'{"key": "value"}'
--option
'{"key1": "value1", "key2": 123, "key3": true, "key4": null, "key5": ["value3", "value4"], "key6": {"value5": "value6"}'