

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

# AWS Batch (`awsbatch`)
<a name="awsbatchcli"></a>

有关的信息 AWS Batch，请参见[AWS Batch](https://aws.amazon.com/batch/)。有关文档，请参阅 [AWS Batch User Guide](https://docs.aws.amazon.com/batch/latest/userguide/)。

**AWS ParallelCluster 的 CLI 命令适用于 AWS Batch**

使用`awsbatch`调度程序时，的 AWS ParallelCluster CLI 命令 AWS Batch 会自动安装在 AWS ParallelCluster 头节点中。CLI 使用 AWS Batch API 操作并允许执行以下操作：
+ 提交和管理作业。
+ 监控作业、队列和主机。
+ 镜像传统调度器命令。

**重要**  
AWS ParallelCluster 不支持 GPU 作业 AWS Batch。有关更多信息，请参阅 [GPU 作业](https://docs.aws.amazon.com/batch/latest/userguide/gpu-jobs.html)。

**Topics**
+ [`awsbsub`](awsbatchcli.awsbsub.md)
+ [`awsbstat`](awsbatchcli.awsbstat.md)
+ [`awsbout`](awsbatchcli_awsbout.md)
+ [`awsbkill`](awsbatchcli_awsbkill.md)
+ [`awsbqueues`](awsbatchcli_awsbqueues.md)
+ [`awsbhosts`](awsbatchcli_awsbhosts.md)

# `awsbsub`
<a name="awsbatchcli.awsbsub"></a>

向集群的作业队列提交作业。

```
awsbsub [-h] [-jn JOB_NAME] [-c CLUSTER] [-cf] [-w WORKING_DIR]
        [-pw PARENT_WORKING_DIR] [-if INPUT_FILE] [-p VCPUS] [-m MEMORY]
        [-e ENV] [-eb ENV_DENYLIST] [-r RETRY_ATTEMPTS] [-t TIMEOUT]
        [-n NODES] [-a ARRAY_SIZE] [-d DEPENDS_ON]
        [command] [arguments [arguments ...]]
```

**重要**  
AWS ParallelCluster 不支持 GPU 作业 AWS Batch。有关更多信息，请参阅 [GPU 作业](https://docs.aws.amazon.com/batch/latest/userguide/gpu-jobs.html)。

## 定位参数
<a name="awsbatchcli.awsbsub.args"></a>

***command***  
提交作业（指定的命令必须在计算实例上可用），或指定要传输的文件名。另请参阅`--command-file`。

**arguments**  
（可选）指定命令或命令文件的参数。

## 命名的参数
<a name="awsbatchcli.awsbsub.namedargs"></a>

**-jn *JOB\$1NAME*, --job-name *JOB\$1NAME***  
为作业命名。第一个字符必须是字母或数字。作业名称可以包含字母（大写和小写）、数字、连字符和下划线，长度不超过 128 个字符。

**-c *CLUSTER*, --cluster *CLUSTER***  
指定要使用的集群。

**-cf, --command-file**  
指示命令是要传输到计算实例的文件。  
默认值：False

**-w *WORKING\$1DIR*, --working-dir *WORKING\$1DIR***  
指定要用作作业的工作目录的文件夹。如果未指定工作目录，则在用户的主目录的 `job-<AWS_BATCH_JOB_ID>` 子文件夹中运行作业。您可以使用此参数或 `--parent-working-dir` 参数。

**-pw *PARENT\$1WORKING\$1DIR*, --parent-working-dir *PARENT\$1WORKING\$1DIR***  
指定作业的工作目录的父文件夹。如果未指定父工作目录，则默认为用户的主目录。在父工作目录中创建名为 `job-<AWS_BATCH_JOB_ID>` 的子文件夹。您可以使用此参数或 `--working-dir` 参数。

**-if *INPUT\$1FILE*, --input-file *INPUT\$1FILE***  
指定要传输到计算实例的文件（在作业的工作目录中）。您可以指定多个输入文件参数。

**-p *VCPUS*, --vcpus *VCPUS***  
指定要为容器保留的 v CPUs 数。与一起使用时`–nodes`，它会标识每个节点CPUs 的 v 数。  
默认：1

**-m *MEMORY*, --memory *MEMORY***  
指定要为作业提供的内存的硬限制（以 MiB 为单位）。如果您的作业尝试超出此处指定的内存限制，则该作业将被结束。  
默认值：128

**-e *ENV*, --env *ENV***  
指定要导出到作业环境的环境变量名称的逗号分隔的列表。要导出所有环境变量，请指定“all”。请注意，“all”环境变量列表不包含 `–env-blacklist` 参数中列出的环境变量，或以 `PCLUSTER_*` 或 `AWS_*` 前缀开头的环境变量。

**-eb *ENV\$1DENYLIST*, --env-blacklist *ENV\$1DENYLIST***  
指定**不**会导出到作业环境的环境变量名称的逗号分隔的列表。默认情况下，不会导出 `HOME`、`PWD`、`USER`、`PATH`、`LD_LIBRARY_PATH`、`TERM` 和 `TERMCAP`。

**-r *RETRY\$1ATTEMPTS*, --retry-attempts *RETRY\$1ATTEMPTS***  
指定要让作业进入 `RUNNABLE` 状态的次数。可以指定 1 到 10 之间的尝试次数。如果尝试次数大于 1，则作业在失败后将重试，直到它进入 `RUNNABLE` 状态的次数达到指定值。  
默认：1

**-t *TIMEOUT*, --timeout *TIMEOUT***  
指定持续时间（以秒为单位）（根据任务尝试`startedAt`的时间戳衡量），如果任务尚未完成，则该持续时间后 AWS Batch 将终止作业。超时值必须至少为 60 秒。

**-n *NODES*, --nodes *NODES***  
指定要为作业预留的节点数量。为此参数指定一个值，以启用多节点并行提交。  
当 [`cluster_type`](cluster-definition.md#cluster-type) 参数设置为 `spot` 时，不支持多节点并行作业。

**-a *ARRAY\$1SIZE*, --array-size *ARRAY\$1SIZE***  
指示数组的大小。您可以指定 2 到 10000 之间的值。如果您为一个作业指定数组属性，该作业将变为数组作业。

**-d *DEPENDS\$1ON*, --depends-on *DEPENDS\$1ON***  
指定作业的依赖项的分号分隔的列表。一个作业可依赖于最多 20 个作业。您可以指定 `SEQUENTIAL` 类型依赖项，而不指定数组作业的作业 ID。顺序依赖项允许每个子数组作业按顺序完成，从索引 0 开始。您也可以使用数组作业的作业 ID 指定 N\$1TO\$1N 类型依赖项。N\$1TO\$1N 依赖项意味着此作业的每个子索引必须等待每个依赖项的相应子索引完成后才能开始。此参数的语法是 “jobid=*<string>*，type=*<string>*;...”。

# `awsbstat`
<a name="awsbatchcli.awsbstat"></a>

显示集群的作业队列中提交的作业。

```
awsbstat [-h] [-c CLUSTER] [-s STATUS] [-e] [-d] [job_ids [job_ids ...]]
```

## 定位参数
<a name="awsbatchcli.awsbstat.arguments"></a>

***job\$1ids***  
指定要在输出中显示的 IDs 以空格分隔的作业列表。如果作业是作业数组，则显示所有子作业。如果请求单个作业，则将以详细版本显示该作业。

## 命名的参数
<a name="awsbatchcli.awsbstat.namedarguments"></a>

**-c *CLUSTER*, --cluster *CLUSTER***  
指示要使用的集群。

**-s *STATUS*, --status *STATUS***  
指定要包含的作业状态的逗号分隔的列表。默认作业状态为“活动”。接受的值为：`SUBMITTED`、`PENDING`、`RUNNABLE`、`STARTING`、`RUNNING`、`SUCCEEDED`、`FAILED` 和 `ALL`。  
默认值：“`SUBMITTED`,`PENDING`,`RUNNABLE`,`STARTING`,`RUNNING`”

**-e, --expand-children**  
展开具有子作业（数组和多节点并行）的作业。  
默认值：False

**-d, --details**  
显示作业详细信息。  
默认值：False

# `awsbout`
<a name="awsbatchcli_awsbout"></a>

显示给定作业的输出。

```
awsbout [ - h ] [ - c CLUSTER ] [ - hd HEAD ] [ - t TAIL ] [ - s ] [ - sp STREAM_PERIOD ] job_id
```

## 定位参数
<a name="awsbatchcli.awsbout.arguments"></a>

***job\$1id***  
指定作业 ID。

## 命名的参数
<a name="awsbatchcli.awsbout.namedarguments"></a>

**-c *CLUSTER*, --cluster *CLUSTER***  
指示要使用的集群。

**-hd *HEAD*, --head *HEAD***  
获取任务输出的第一*HEAD*行。

**-t *TAIL*, --tail *TAIL***  
获取作业输出的最后几个 <tail> 行。

**-s, --stream**  
获取作业输出，然后等待生成其他输出。此参数可与 –tail 一起使用，以从作业输出的最新 <tail> 行开始。  
默认值：False

**-sp *STREAM\$1PERIOD*, --stream-period *STREAM\$1PERIOD***  
设置流式传输时段。  
默认：5

# `awsbkill`
<a name="awsbatchcli_awsbkill"></a>

取消或终止集群中提交的作业。

```
awsbkill [ - h ] [ - c CLUSTER ] [ - r REASON ] job_ids [ job_ids ... ]
```

## 定位参数
<a name="awsbatchcli.awsbkill.arguments"></a>

***job\$1ids***  
指定要取消或终止的 IDs 以空格分隔的作业列表。

## 命名的参数
<a name="awsbatchcli.awsbkill.namedarguments"></a>

**-c *CLUSTER*, --cluster *CLUSTER***  
指示要使用的集群的名称。

**-r *REASON*, --reason *REASON***  
指示要附加到作业的消息，并说明取消作业的原因。  
默认值：“Terminated by the user”

# `awsbqueues`
<a name="awsbatchcli_awsbqueues"></a>

显示与集群关联的作业队列。

```
awsbqueues [ - h ] [ - c CLUSTER ] [ - d ] [ job_queues [ job_queues ... ]]
```

## 定位参数
<a name="awsbatchcli.awsbqueues.arguments"></a>

***job\$1queues***  
指定要显示的队列的空格分隔的列表。如果请求单个队列，则将以详细版本显示该队列。

## 命名的参数
<a name="awsbatchcli.awsbqueues.namedarguments"></a>

**-c *CLUSTER*, --cluster *CLUSTER***  
指定要使用的集群的名称。

**-d, --details**  
指明是否显示队列的详细信息。  
默认值：False

# `awsbhosts`
<a name="awsbatchcli_awsbhosts"></a>

显示属于集群的计算环境的主机。

```
awsbhosts [ - h ] [ - c CLUSTER ] [ - d ] [ instance_ids [ instance_ids ... ]]
```

## 定位参数
<a name="awsbatchcli.awsbhosts.arguments"></a>

***instance\$1ids***  
指定以空格分隔的实例 IDs列表。如果请求单个实例，则将以详细版本显示该实例。

## 命名的参数
<a name="awsbatchcli.awsbhosts.namedarguments"></a>

**-c *CLUSTER*, --cluster *CLUSTER***  
指定要使用的集群的名称。

**-d, --details**  
指示是否显示主机的详细信息。  
默认值：False