docs.aws.amazon.com Open in urlscan Pro
18.66.147.13  Public Scan

Form analysis
1 forms found in the DOM

GET ../../search.html

<form class="form-search margin-top-1em" action="../../search.html" method="get">
  <label for="searchbox">Search box</label>
  <input id="searchbox" type="search" name="q" style="width: 105px" class="input-small search-query" autocomplete="off">
  <button type="submit" class="btn btn-small">Search</button>
  <input type="hidden" name="check_keywords" value="yes">
  <input type="hidden" name="area" value="default">
</form>

Text Content

SELECT YOUR COOKIE PREFERENCES

We use essential cookies and similar tools that are necessary to provide our
site and services. We use performance cookies to collect anonymous statistics so
we can understand how customers use our site and make improvements. Essential
cookies cannot be deactivated, but you can click “Customize cookies” to decline
performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide
useful site features, remember your preferences, and display relevant content,
including relevant advertising. To continue without accepting these cookies,
click “Continue without accepting.” To make more detailed choices or learn more,
click “Customize cookies.”

Accept all cookiesContinue without acceptingCustomize cookies


CUSTOMIZE COOKIE PREFERENCES

We use cookies and similar tools (collectively, "cookies") for the following
purposes.


ESSENTIAL

Essential cookies are necessary to provide our site and services and cannot be
deactivated. They are usually set in response to your actions on the site, such
as setting your privacy preferences, signing in, or filling in forms.




PERFORMANCE

Performance cookies provide anonymous statistics about how customers navigate
our site so we can improve site experience and performance. Approved third
parties may perform analytics on our behalf, but they cannot use the data for
their own purposes.

Allow performance category
Allowed


FUNCTIONAL

Functional cookies help us provide useful site features, remember your
preferences, and display relevant content. Approved third parties may set these
cookies to provide certain site features. If you do not allow these cookies,
then some or all of these services may not function properly.

Allow functional category
Allowed


ADVERTISING

Advertising cookies may be set through our site by us or our advertising
partners and help us deliver relevant marketing content. If you do not allow
these cookies, you will experience less relevant advertising.

Allow advertising category
Allowed

Blocking some types of cookies may impact your experience of our sites. You may
review and change your choices at any time by clicking Cookie preferences in the
footer of this site. We and selected third-parties use cookies or similar
technologies as specified in the AWS Cookie Notice.

CancelSave preferences




UNABLE TO SAVE COOKIE PREFERENCES

We will only store essential cookies at this time, because we were unable to
save your cookie preferences.

If you want to change your cookie preferences, try again later using the link in
the AWS console footer, or contact support if the problem persists.

Dismiss


AWS CLI Command Reference
 * Home
 * User Guide
 * Forum
 * GitHub




NAVIGATION

 * index
 * next |
 * previous |
 * AWS CLI 1.29.63 Command Reference »
 * aws »
 * rds »

 * ← describe-blue-green-deployments /
 * describe-db-cluster-automated-backups →


TABLE OF CONTENTS

 * describe-certificates
   * Description
   * Synopsis
   * Options
   * Global Options
   * Examples
   * Output


QUICK SEARCH

Search box Search


FEEDBACK

Did you find this page useful? Do you have a suggestion to improve the
documentation? Give us feedback.
If you would like to suggest an improvement or fix for the AWS CLI, check out
our contributing guide on GitHub.


USER GUIDE

First time using the AWS CLI? See the User Guide for help getting started.


NOTE:

You are viewing the documentation for an older major version of the AWS CLI
(version 1).



AWS CLI version 2, the latest major version of AWS CLI, is now stable and
recommended for general use. To view this page for the AWS CLI version 2, click
here. For more information see the AWS CLI version 2 installation instructions
and migration guide.

[ aws . rds ]


DESCRIBE-CERTIFICATES¶


DESCRIPTION¶

Lists the set of certificate authority (CA) certificates provided by Amazon RDS
for this Amazon Web Services account.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance
in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB
cluster in the Amazon Aurora User Guide .

See also: AWS API Documentation

describe-certificates is a paginated operation. Multiple API calls may be issued
in order to retrieve the entire data set of results. You can disable pagination
by providing the --no-paginate argument. When using --output text and the
--query argument on a paginated response, the --query argument must extract data
from the results of the following query expressions: Certificates


SYNOPSIS¶

  describe-certificates
[--certificate-identifier <value>]
[--filters <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]



OPTIONS¶

--certificate-identifier (string)

> The user-supplied certificate identifier. If this parameter is specified,
> information for only the identified certificate is returned. This parameter
> isn't case-sensitive.
> 
> Constraints:
> 
>  * Must match an existing CertificateIdentifier.

--filters (list)

> This parameter isn't currently supported.
> 
> (structure)
> 
> > A filter name and value pair that is used to return a more specific list of
> > results from a describe operation. Filters can be used to match a set of
> > resources by specific criteria, such as IDs. The filters supported by a
> > describe operation are documented with the describe operation.
> > 
> > 
> > NOTE
> > 
> > Currently, wildcards are not supported in filters.
> > 
> > The following actions can be filtered:
> > 
> >  * DescribeDBClusterBacktracks
> >  * DescribeDBClusterEndpoints
> >  * DescribeDBClusters
> >  * DescribeDBInstances
> >  * DescribePendingMaintenanceActions
> > 
> > Name -> (string)
> > 
> > > The name of the filter. Filter names are case-sensitive.
> > 
> > Values -> (list)
> > 
> > > One or more filter values. Filter values are case-sensitive.
> > > 
> > > (string)

Shorthand Syntax:

Name=string,Values=string,string ...


JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]


--cli-input-json (string) Performs service operation based on the JSON string
provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line,
the CLI values will override the JSON-provided values. It is not possible to
pass arbitrary binary values using a JSON-provided value as the string will be
taken literally.

--starting-token (string)

> A token to specify where to start paginating. This is the NextToken from a
> previously truncated response.
> 
> For usage examples, see Pagination in the AWS Command Line Interface User
> Guide .

--page-size (integer)

> The size of each page to get in the AWS service call. This does not affect the
> number of items returned in the command's output. Setting a smaller page size
> results in more calls to the AWS service, retrieving fewer items in each call.
> This can help prevent the AWS service calls from timing out.
> 
> For usage examples, see Pagination in the AWS Command Line Interface User
> Guide .

--max-items (integer)

> The total number of items to return in the command's output. If the total
> number of items available is more than the value specified, a NextToken is
> provided in the command's output. To resume pagination, provide the NextToken
> value in the starting-token argument of a subsequent command. Do not use the
> NextToken response element directly outside of the AWS CLI.
> 
> For usage examples, see Pagination in the AWS Command Line Interface User
> Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output
without sending an API request. If provided with no value or the value input,
prints a sample input JSON that can be used as an argument for --cli-input-json.
If provided with the value output, it validates the command inputs and returns a
sample output JSON for that command.


GLOBAL OPTIONS¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each
SSL connection, the AWS CLI will verify SSL certificates. This option overrides
the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

 * json
 * text
 * table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

 * on
 * off
 * auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is
provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides
config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket
read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket
connect will be blocking and not timeout. The default value is 60 seconds.


EXAMPLES¶


NOTE

To use the following examples, you must have the AWS CLI installed and
configured. See the Getting started guide in the AWS CLI User Guide for more
information.

Unless otherwise stated, all examples have unix-like quotation rules. These
examples will need to be adapted to your terminal's quoting rules. See Using
quotation marks with strings in the AWS CLI User Guide .

To describe certificates

The following describe-certificates example retrieves the details of the
certificate associated with the user's default region.

aws rds describe-certificates


Output:

{
    "Certificates": [
        {
            "Thumbprint": "34478a908a83ae45dcb61676d235ece975c62c63",
            "ValidFrom": "2015-02-05T21:54:04Z",
            "CertificateIdentifier": "rds-ca-2015",
            "ValidTill": "2020-03-05T21:54:04Z",
            "CertificateType": "CA",
            "CertificateArn": "arn:aws:rds:us-east-1::cert:rds-ca-2015"
        }
    ]
}



OUTPUT¶

DefaultCertificateForNewLaunches -> (string)

> The default root CA for new databases created by your Amazon Web Services
> account. This is either the root CA override set on your Amazon Web Services
> account or the system default CA for the Region if no override exists. To
> override the default CA, use the ModifyCertificates operation.

Certificates -> (list)

> The list of Certificate objects for the Amazon Web Services account.
> 
> (structure)
> 
> > A CA certificate for an Amazon Web Services account.
> > 
> > For more information, see Using SSL/TLS to encrypt a connection to a DB
> > instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a
> > connection to a DB cluster in the Amazon Aurora User Guide .
> > 
> > CertificateIdentifier -> (string)
> > 
> > > The unique key that identifies a certificate.
> > 
> > CertificateType -> (string)
> > 
> > > The type of the certificate.
> > 
> > Thumbprint -> (string)
> > 
> > > The thumbprint of the certificate.
> > 
> > ValidFrom -> (timestamp)
> > 
> > > The starting date from which the certificate is valid.
> > 
> > ValidTill -> (timestamp)
> > 
> > > The final date that the certificate continues to be valid.
> > 
> > CertificateArn -> (string)
> > 
> > > The Amazon Resource Name (ARN) for the certificate.
> > 
> > CustomerOverride -> (boolean)
> > 
> > > Indicates whether there is an override for the default certificate
> > > identifier.
> > 
> > CustomerOverrideValidTill -> (timestamp)
> > 
> > > If there is an override for the default certificate identifier, when the
> > > override expires.

Marker -> (string)

> An optional pagination token provided by a previous DescribeCertificates
> request. If this parameter is specified, the response includes only records
> beyond the marker, up to the value specified by MaxRecords .


 * ← describe-blue-green-deployments /
 * describe-db-cluster-automated-backups →


NAVIGATION

 * index
 * next |
 * previous |
 * AWS CLI 1.29.63 Command Reference »
 * aws »
 * rds »

Privacy | Site terms | Cookie preferences | © 2023, Amazon Web Services, Inc. or
its affiliates. All rights reserved.