Provided by: rdscli_1.10.003-0ubuntu1_all bug

NAME

       rds-describe-db-subnet-groups - Describes a given or all database subnet groups

SYNOPSIS

        rds-describe-db-subnet-groups
           [DBSubnetGroupName] [--marker  value ] [--max-records  value ]
            [General Options]

DESCRIPTION

           Returns description of given database subnet group or all database subnet
        groups for the customer if no group name is given.

ARGUMENTS

        DBSubnetGroupName
           The name of the database subnet group. You can also set this value using
           "--db-subnet-group-name".

GENERAL OPTIONS

        --aws-credential-file VALUE
           Location of the file with your AWS credentials. Must not be specified in
           conjunction with --ec2-cert-file-path or --ec2-private-key-file-path.
           This value can be set by using the environment variable
           'AWS_CREDENTIAL_FILE'.

        -C, --ec2-cert-file-path VALUE
           Path to 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 environment
           variable 'EC2_CERT'.

        --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.

        -K, --ec2-private-key-file-path VALUE
           Path to 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 environment
           variable 'EC2_PRIVATE_KEY'.

        --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.

        --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.

        --service-sig-name VALUE
           Specify the service name to use when signing requests.  The default is
           "rds". This value can be set by using the environment variable
           'SERVICE_SIG_NAME'.

        --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 'RDS_URL'.

INPUT EXAMPLES

        This shows how to get description of all the subnet groups

       $PROMPT>rds-describe-db-subnet-groups

OUTPUT

        This command returns a table that contains the following:
        * Name - Subnet Group name.
        * Description - Subnet Group description.
        * Status - Status of the DB Subnet Group.
        * VpcId - Vpc Id of the Subnet Group.
        * Subnet Identifier - Subnet Group Identifier.
        * Subnet Availability Zone - Subnet Availability Zone.
        * Status - Status of Subnet.

OUTPUT EXAMPLES

        Short output for Subnet Groups with headers displayed

SEE ALSO

         http://docs.amazonwebservices.com/AmazonRDS/2012-09-17/CommandLineReference/
         http://docs.amazonwebservices.com/AmazonRDS/latest/CommandLineReference