Menu
Amazon Relational Database Service
Command Line Interface Reference (API Version 2014-10-31)

Common Options for API Tools

The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon RDS.

The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To download an entire log file at once, rather than in parts using the download-db-log-file-portion command, use the last published RDS CLI and the rds-download-db-logfile command.

Most API tools described in this section accept the set of optional parameters described in the following table.

Option Description

--aws-credential-file value

Path to the file containing your AWS credentials. This value can be stored in the AWS_CREDENTIAL_FILE environment variable.

Example: --aws-credential-file c:\AWS\mycredemtials.pek

--ec2-cert-file-path value

-C value

Path to an AWS X.509 certificate file. Must be specified in conjunction with --ec2-private-key-file-path and must not be specified in conjunction with --aws-credential-file. This value can be set by using the EC2_CERT environment variable.

--connection-timeout value

Specifies the connection timeout in seconds.

Default: 30

Example: --connection-timeout 60

--debug

Causes debug information to be displayed on error.

Default: false

--delimiter value

Specifies the delimiter to use when displaying long results.

Default: comma

--headers

Displays column headers for tabular or delimited results, or HTTP headers for XML results.

Default: off

--help

Displays help text for the command. You can also use help commandname.

Default: off

-I value

--access-key-id value

Specifies the AWS access key ID to use for requests.

-K value

--ec2-private-key-file-path value

Path to an AWS X.509 private key file. Must be specified in conjunction with --ec2-cert-file-path and must not be specified in conjunction with --aws-credential-file. This value can be set by using the EC2_PRIVATE_KEY environment variable.

--region value

Overrides the Region specified in the EC2_REGION environment variable.

Default: The EC2_REGION environment variable, or us-east-1 if the EC2_REGION environment variable is not set.

Example: --region eu-west-1

-S value

--secret-key-value value

Specifies the AWS secret access key to use for requests.

--show-empty-fields

Show empty fields and rows with a (nil) value.

--show-request

Displays the URL used to call the AWS service.

--show-table

Displays the results of the command in fixed column-width format. Empty fields are not displayed. This is the default output format.

--show-long

Displays the results of the command delimited by a character. Empty fields are shown as "(nil). The default delimiter character is a comma.

--show-xml

Displays the results of the command as raw XML.

--quiet

Suppress all output from the command.

-U value

--url value

Override the URL for the service call with the value supplied.

This value is set using the RDS_URL environment variable.

Note

You can set the EC2_REGION environment variable or use the --region parameter to avoid having to pass the --url parameter to specify a different regional endpoint.