Menu
AWS Certificate Manager
API Reference (API Version 2015-12-08)

ListCertificates

Retrieves a list of ACM Certificates and the domain name for each. You can optionally filter the list to return only the certificates that match the specified status.

Request Syntax

{
   "CertificateStatuses": [ "string" ],
   "MaxItems": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

CertificateStatuses

The status or statuses on which to filter the list of ACM Certificates.

Type: array of Strings

Valid Values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED

Required: No

MaxItems

Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 320.

Pattern: [\u0009\u000A\u000D\u0020-\u00FF]*

Required: No

Response Syntax

{
   "CertificateSummaryList": [ 
      { 
         "CertificateArn": "string",
         "DomainName": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CertificateSummaryList

A list of ACM Certificates.

Type: array of CertificateSummary objects

NextToken

When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 320.

Pattern: [\u0009\u000A\u000D\u0020-\u00FF]*

Errors

For information about the errors that are common to all actions, see Common Errors.

Example

List Certificates

Sample Request

POST / HTTP/1.1
Host: acm.us-east-1.amazonaws.com
Content-Length: 2
X-Amz-Target: CertificateManager.ListCertificates
X-Amz-Date: 20160602T185849Z
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256\
 Credential=AKIAI44QH8DHBEXAMPLE/20160602/us-east-1/acm/aws4_request,\
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,\
 Signature=13cfab2fbac91594da31999325c8a64da70a053a731fd237501bfbc10a24e311

{}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 0be6b8db-28f4-11e6-87c4-d92106aa4389
Content-Type: application/x-amz-json-1.1
Date: Thu, 02 Jun 2016 18:58:51 GMT

{"CertificateSummaryList": [
  {
    "CertificateArn": "arn:aws:acm:us-east-1:111122223333:certificate/12345678-1234-1234-1234-123456789012",
    "DomainName": "www.example.com"
  },
  {
    "CertificateArn": "arn:aws:acm:us-east-1:111122223333:certificate/87654321-5678-5678-5678-210987654321",
    "DomainName": "www.example.net"
  }
]}