SYNOPSIS
elasticache-describe-reserved-cache-nodes
[ReservedCacheNodeId] [--cache-node-type value ] [--duration value ]
[--marker value ] [--max-records value ] [--offering-type value ]
[--product-description value ] [--reserved-cache-node-offering-id value
] [General Options]
DESCRIPTION
Returns information about the cache node reservations for this account. If
you pass in a ReservedCacheNodeId, it will return information only about
that reservation. There are several optional parameters that allow you to
filter the results.
ARGUMENTS
ReservedCacheNodeId
User-supplied reserved cache node identifier. This is the unique key that
identifies a cache node reservation. Not case-sensitive. You can also set
this value using "--reserved-cache-node-id".
SPECIFIC OPTIONS
-c, --cache-node-type VALUE
If specified, only reservations for this node type will be shown.
-d, --duration VALUE
If specified, only reservations for this duration will be shown.
-o, --reserved-cache-node-offering-id VALUE
If specified, only reservations for this offering will be shown.
-p, --product-description VALUE
If specified, only reservations with the specified description will be
shown.
-t, --offering-type VALUE
If specified, only reservations for this offering type will be shown.
GENERAL OPTIONS
--aws-credential-file VALUE
Location of the file with your AWS credentials. This value can be set by
using the environment variable 'AWS_CREDENTIAL_FILE'.
--connection-timeout VALUE
Specify a connection timeout VALUE (in seconds) for API calls. The
default value is '30'.
--debug
If an error occurs while --debug is used, it will display information
useful for debugging the problem. The default value is 'false'.
--delimiter VALUE
What delimiter to use when displaying delimited (long) results.
--headers
If you are displaying tabular or delimited results, it includes the
column headers. If you are showing xml results, it returns the HTTP
headers from the service request, if applicable. This is off by default.
-I, --access-key-id VALUE
Specify the AWS Access ID to use.
--marker VALUE
The marker provided in the previous request. If this parameter is
specified the response includes only records beyond the marker, up to
MaxRecords.
--max-records VALUE
Maximum number of records to return per page. Allowed value range for
this parameter is 20-100, default value is 100.
--region VALUE
Specify region VALUE as the web service region to use. This value can be
set by using the environment variable 'EC2_REGION'.
-S, --secret-key VALUE
Specify the AWS Secret Key to use.
--show-empty-fields
Show empty fields and rows, using a "(nil)" value. The default is to not
show empty fields or columns.
--show-request
Displays the URL used by the tools to call the AWS Service. The default
value is 'false'.
--show-table, --show-long, --show-xml, --quiet
Specify how the results are displayed: tabular, delimited (long), xml, or
no output (quiet). Tabular shows a subset of the data in fixed
column-width form, while long shows all of the returned values delimited
by a character. The xml is the raw return from the service, while quiet
suppresses all standard output. The default is tabular, or 'show-table'.
-U, --url VALUE
This option will override the URL for the service call with VALUE. This
value can be set by using the environment variable 'AWS_ELASTICACHE_URL'.
INPUT EXAMPLES
Returns descriptions of all of your cache node reservations.
$PROMPT>elasticache-describe-reserved-cache-nodes
Returns a description of a specific cache node reservation, showing table
headers
$PROMPT>elasticache-describe-reserved-cache-nodes reservation1 --headers
Returns a full description of a specific cache node reservation, showing
table headers
$PROMPT>elasticache-describe-reserved-cache-nodes reservation1 --show-long --headers
OUTPUT
This command returns a table that contains the following:
* ReservationId - Unique identifier of the reservation.
* OfferingId - Offering identifier for the reservation. This column appears
only in the --show-long view.
* Type - Type of cache nodes to which the reservation applies.
* Start Time - Time at which the reservation began.
* Duration - Length of the reservation period in years.
* Fixed Price - Fixed price charged for each cache node in this reservation.
* Usage Price - Hourly price to run each reserved cache node.
* Count - Number of cache nodes reserved.
* State - Payment status.
* Description - Indicates the cache engine for the reservation.
* Offering Type - Offering type for the reservation.
* Amount - Recurring price charged to run this reserved cache node.
* Frequency - The frequency at which the amount is charged to run this
reserved cache node.
OUTPUT EXAMPLES
Output with column headers