A Quick Overview of the CLI Options

By John Paul Mueller

Part of Amazon Web Services For Developers For Dummies Cheat Sheet

When working with the aws command to perform CLI tasks, you often need to add options to ensure that the commands work as intended. The following table gives you an overview of these options so that you can gain access to them quickly.

Option Input Description
--debug boolean Turn debug logging on or off.
--endpoint-url string Use a different URL from the standard URL. For example, you can use a localhost rather than the remote AWS copy when interacting with DynamoDB.
--no-verify-ssl boolean Disable SSL verification when communicating with AWS services. On the plus side, this option makes communication faster. On the negative side, it can open your system to attack. In general, using this particular option is a bad idea.
--no-paginate boolean Stop using pagination for output. The output streams from beginning to end so that you don’t have to press the spacebar to display the next page of output.
--output string Defines the output style for responses. The acceptable output values are json, text, and table.
--query string Specifies the JSON Matching Expression Path (JMESPath) query to use when filtering response data. The site at http://jmespath.org/ tells you more about using this query method.
--profile string Determines the profile that the aws command uses when making queries. Normally, the aws command uses the default profile (generally, the first profile you create when performing setup).
--region string Determines which region the aws command uses when making queries. This option overrides the config/env settings.
--version Displays the tool version. You don’t need to supply any input value.
--color string Turns color output on or off. The valid input values are on, off, and auto.
--no-sign-request boolean Sends requests without signing them. The requests will usually fail if you don’t send credentials, so this is one method of testing security.
--ca-bundle string Specifies the CA certificate bundle to use when verifying SSL certificates. This option overrides the config/env settings.
--cli-read-timeout int Defines the maximum socket read time in seconds. This value helps you recover from requests that freeze for whatever reason. Setting this value to 0 will stop the request from timing out, which means that aws will wait forever for the request to succeed.
--cli-connect-timeout int Defines the maximum socket connect time in seconds. This value helps you recover from requests that freeze for whatever reason. Setting this value to 0 will stop the request from timing out, which means that aws will wait forever for the request to succeed.