Menu
AWS Tools for Microsoft Visual Studio Team Services
User Guide

AWS CLI

Synopsis

Runs a command using the AWS CLI. Note that you must have the AWS CLI installed to use this task. See Installing the AWS Command Line Interface for more details.

Description

The AWS CLI uses a multipart structure on the command line. It starts with the base call to AWS. The next part specifies a top-level command, which often represents an AWS service that the AWS CLI supports. Each AWS service has additional subcommands that specify the operation to perform. You can specify the general AWS CLI options, or the specific parameters for an operation, in any order on the command line. If you specify an exclusive parameter multiple times, only the last value applies.

<command> <subcommand> [options and parameters]

Parameters can take various types of input values such as numbers, strings, lists, maps, and JSON structures.

Parameters

You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional.

Displayname*

The default name of the task, AWS CLI. You can rename it.

AWS Credentials*

The AWS credentials to use. If needed, choose +, and then add a new AWS connection.

AWS Region*

The AWS Region name to use. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

Command*

The AWS CLI command to run. Run aws help in the AWS Command Line Interface to get a complete list of commands, or see CommandStructure in the AWS Command Line Interface.

Subcommand

The AWS CLI subcommand to run. Run aws help in the AWS Command Line Interface to get a complete list of commands, or see CommandStructure in the AWS Command Line Interface.

Options and Parameters

The arguments to pass to the AWS CLI command. Run aws <command> --help in the AWS Command Line Interface to get the complete list of arguments supported by the command.

Advanced

Fail on Standard Error

If true, this task fails if any errors are written to the StandardError stream.