Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetCertificates

Returns information about one or more Amazon Lightsail SSL/TLS certificates.

Note

To get a summary of a certificate, omit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

Request Syntax


{
   "certificateName": "string",
   "certificateStatuses": [ "string" ],
   "includeCertificateDetails": boolean,
   "pageToken": "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.

certificateName

The name for the certificate for which to return information.

When omitted, the response includes all of your certificates in the AWS Region where the request is made.

Type: String

Required: No

certificateStatuses

The status of the certificates for which to return information.

For example, specify ISSUED to return only certificates with an ISSUED status.

When omitted, the response includes all of your certificates in the AWS Region where the request is made, regardless of their current status.

Type: Array of strings

Required: No

includeCertificateDetails

Indicates whether to include detailed information about the certificates in the response.

When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.

Type: Boolean

Required: No

pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetCertificates request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Type: String

Required: No

Response Syntax


{
   "certificates": [ 
      { 
         "certificateArn": "string",
         "certificateDetail": { 
            "arn": "string",
            "createdAt": number,
            "domainName": "string",
            "domainValidationRecords": [ 
               { 
                  "dnsRecordCreationState": { 
                     "code": "string",
                     "message": "string"
                  },
                  "domainName": "string",
                  "resourceRecord": { 
                     "name": "string",
                     "type": "string",
                     "value": "string"
                  },
                  "validationStatus": "string"
               }
            ],
            "eligibleToRenew": "string",
            "inUseResourceCount": number,
            "issuedAt": number,
            "issuerCA": "string",
            "keyAlgorithm": "string",
            "name": "string",
            "notAfter": number,
            "notBefore": number,
            "renewalSummary": { 
               "domainValidationRecords": [ 
                  { 
                     "dnsRecordCreationState": { 
                        "code": "string",
                        "message": "string"
                     },
                     "domainName": "string",
                     "resourceRecord": { 
                        "name": "string",
                        "type": "string",
                        "value": "string"
                     },
                     "validationStatus": "string"
                  }
               ],
               "renewalStatus": "string",
               "renewalStatusReason": "string",
               "updatedAt": number
            },
            "requestFailureReason": "string",
            "revocationReason": "string",
            "revokedAt": number,
            "serialNumber": "string",
            "status": "string",
            "subjectAlternativeNames": [ "string" ],
            "supportCode": "string",
            "tags": [ 
               { 
                  "key": "string",
                  "value": "string"
               }
            ]
         },
         "certificateName": "string",
         "domainName": "string",
         "tags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ]
      }
   ],
   "nextPageToken": "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.

certificates

An object that describes certificates.

Type: Array of CertificateSummary objects

nextPageToken

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Type: String

Errors

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

AccessDeniedException

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

HTTP Status Code: 400

InvalidInputException

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Note

Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

HTTP Status Code: 400

NotFoundException

Lightsail throws this exception when it cannot find a resource.

HTTP Status Code: 400

ServiceException

A general service exception.

HTTP Status Code: 500

UnauthenticatedException

Lightsail throws this exception when the user has not been authenticated.

HTTP Status Code: 400