使用中的分页选项 AWS CLI - AWS Command Line Interface
服务器端分页客户端分页程序

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

使用中的分页选项 AWS CLI

本主题介绍分页 AWS CLI的输出的不同方式。

主要有两种方法可以从 AWS CLI控制分页。

服务器端分页参数会先进行处理，然后系统会将所有输出发送到客户端分页程序进行处理。

服务器端分页

对于可以返回大型项目列表的命令，当 AWS CLI 调用服务来填充列表时， AWS Command Line Interface (AWS CLI) 有多个选项可以控制输出中包含API的项目数量。

默认情况下， AWS CLI 使用由各个服务确定的页面大小并检索所有可用项目。例如，Amazon S3 的原定设置页面大小为 1000。如果您在包含 3500 个对象的 Amazon S3 存储桶上运行 aws s3api list-objects，则 AWS CLI 将自动对 Amazon S3 发出四次调用，以在后台处理服务特定分页逻辑并在最终输出中返回所有 3500 个对象。

如何使用 --no-paginate 参数

--no-paginate 选项在客户端禁用以下分页标记。使用命令时，默认情况下， AWS CLI 会自动进行多次调用以返回所有可能的结果以创建分页。每页显示一次调用的结果。禁用分页 AWS CLI 只能调用一次命令结果的第一页。

例如，如果您在包含 3,500 个对象的 Amazon S3 存储桶aws s3api list-objects上运行，则 AWS CLI 只会首次调用 Amazon S3，只返回最终输出中的前 1,000 个对象。

$ aws s3api list-objects \
    --bucket amzn-s3-demo-bucket \
    --no-paginate
{
    "Contents": [
...

如何使用 --page-size 参数

如果您在对大量资源运行列表命令时发现问题，则表明原定设置页面大小可能过大。这可能导致对 AWS 服务的调用超过允许的最大时间，并生成 “超时” 错误。您可以使用--page-size选项来指定每次调用 AWS 服务时 AWS CLI 请求的项目数量较少。 AWS CLI 仍会检索完整列表，但在后台执行的服务API调用次数较多，每次调用检索的项目数量也较少。这样，各个调用成功的可能性会更高且不会发生超时。更改页面大小不会影响输出；它只会影响生成输出所需的API调用次数。

$ aws s3api list-objects \
    --bucket amzn-s3-demo-bucket \
    --page-size 100
{
    "Contents": [
...

如何使用 --max-items 参数

要在 AWS CLI 输出中一次包含更少的项目，请使用--max-items选项。 AWS CLI 仍如前所述，使用服务进行分页，但一次只能打印出您指定的项目数量。

$ aws s3api list-objects \
    --bucket amzn-s3-demo-bucket \
    --max-items 100
{
    "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAxfQ==",
    "Contents": [
...

如何使用 --starting-token 参数

如果 output (--max-items) 的项目数小于底层API调用返回的项目总数，则输出中NextToken包含一个，您可以将其传递给后续命令以检索下一组项目。以下示例显示如何使用上一示例返回的 NextToken 值，并使您能够检索接下来的 100 个项目。

注意

参数 --starting-token 不能为空。如果上一个命令未返回 NextToken 值，则没有更多项目可返回，您不需要再次调用该命令。

$ aws s3api list-objects \
    --bucket amzn-s3-demo-bucket \
    --max-items 100 \
    --starting-token eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAxfQ==
{
    "Contents": [
...

每次致电时，指定的 AWS 服务可能不会按相同的顺序退回商品。如果您为 --page-size 和 --max-items 指定不同的值，您可能会获得意外结果（项目缺失或重复）。为防止出现这种情况，请对 --page-size 和 --max-items 使用相同的数字，以同步 AWS CLI 的分页与基础服务的分页。您还可以检索整个列表并在本地执行任何必需的分页操作。

客户端分页程序

AWS CLI 版本 2 允许使用客户端寻呼机程序进行输出。默认情况下，此功能会通过操作系统的默认分页程序返回所有输出。

您可以按照优先级顺序，通过以下方式指定输出分页程序：

  • 使用 default 或所指定配置文件的 config 文件中的 cli_pager 设置。

  • 使用 AWS_PAGER 环境变量。

  • 使用 PAGER 环境变量。

您可以按照优先级顺序，通过以下方式完全禁止对外部分页程序的使用：

  • 使用 --no-cli-pager 命令行选项可禁止在单个命令中使用分页程序。

  • 将 cli_pager 设置或 AWS_PAGER 变量设置为空字符串。

如何使用 cli_pager 设置

您可以将常用的配置设置和凭证保存在由 AWS CLI维护的文件中。所指定配置文件中的设置优先于 default 配置文件中的设置。有关配置设置的更多信息，请参阅中的配置和凭据文件设置 AWS CLI。

以下示例将默认输出分页程序设置为 less 程序。

[default]
cli_pager=less

以下示例将默认值设置为禁用分页程序。

[default]
cli_pager=

如何设置AWS_PAGER环境变量

以下示例将默认输出分页程序设置为 less 程序。有关环境变量的更多信息，请参阅为配置环境变量 AWS CLI。

Linux and macOS
$ export AWS_PAGER="less"
Windows
C:\> setx AWS_PAGER "less"

如何使用--no-cli-pager 选项

要对单个命令禁止使用分页程序，请使用 --no-cli-pager 选项。有关命令行选项的更多信息，请参阅中的命令行选项 AWS CLI。

$ aws s3api list-objects \
    --bucket amzn-s3-demo-bucket \
    --no-cli-pager
{
    "Contents": [
...

如何使用分页程序标志

您可以指定要对分页程序自动使用的标志。标志取决于您使用的分页程序。以下示例适用于 less 和 more 的典型默认值。

Linux and macOS

如果您未另行指定，则默认情况下，第 2 AWS CLI 版使用的寻呼机版本为less。如果您没有设置LESS环境变量，则 AWS CLI 版本 2 将使用这些标FRX志。您可以通过在设置 AWS CLI 寻呼机时指定标志来组合标志。

以下示例使用 S 标志。然后，此标志与默认 FRX 标志结合使用，创建最终 FRXS 标志。

$ export AWS_PAGER="less -S"

如果您不希望使用任何 FRX 标志，您可以对它们取否定值。以下示例对 F 标志取否定值，创建最终 RX 标志。

$ export AWS_PAGER="less -+F"

有关 less 标志的更多信息，请参阅 manpages.org 上的 less。

Windows

如果您未另行指定，则默认情况下， AWS CLI 版本 2 使用的寻呼机没有其他标志。more

以下示例使用 /c 参数。

C:\> setx AWS_PAGER "more /c"

有关more旗帜的更多信息，请参阅 Micros more oft 文档。