.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.9. .TH TXAWS-DISCOVER "1" "May 2012" "txaws-discover 0.2.3" "User Commands" .SH NAME txaws-discover \- txAWS AWS API discovery tool .SH SYNOPSIS .B txaws-discover [\fI--key KEY\fR] [\fI--secret SECRET\fR] [\fI--endpoint ENDPOINT\fR] .SH DESCRIPTION Purpose: Invoke an EC2 API method with arbitrary parameters. .IP \fB\-\-action\fR ACTION [PARAMETERS, ...] .SH OPTIONS .TP \fB\-\-key\fR The AWS access key to use when making the API request. .TP \fB\-\-secret\fR The AWS secret key to use when making the API request. .TP \fB\-\-endpoint\fR The region endpoint to make the API request against. .TP \fB\-\-action\fR The name of the EC2 API to invoke. .TP \fB\-h\fR, \fB\-\-help\fR Show help message. .SS "Description:" .TP The purpose of this program is to aid discovery of the EC2 API. It can run .TP any EC2 API method, with arbitrary parameters. The response received from .IP the backend cloud is printed to the screen, to show exactly what happened in response to the request. The \fB\-\-key\fR, \fB\-\-secret\fR, \fB\-\-endpoint\fR and \fB\-\-action\fR command\-line arguments are required. If AWS_ENDPOINT, AWS_ACCESS_KEY_ID or AWS_SECRET_ACCESS_KEY environment variables are defined the corresponding options can be omitted and the values defined in the environment variables will be used. .IP Any additional parameters, beyond those defined above, will be included with the request as method parameters. .SH EXAMPLES .IP The following examples omit the \fB\-\-key\fR, \fB\-\-secret\fR and \fB\-\-endpoint\fR command\-line arguments for brevity. They must be included unless corresponding values are available from the environment. .IP Run the DescribeRegions method, without any optional parameters: .IP txaws\-discover \fB\-\-action\fR DescribeRegions .IP Run the DescribeRegions method, with an optional RegionName.0 parameter: .IP txaws\-discover \fB\-\-action\fR DescribeRegions \fB\-\-RegionName\fR.0 us\-west\-1