Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListEmailIdentityCertificates

Lists the S/MIME certificates that are associated with the specified email identity. The results include certificates in all states, such as PROVISIONING, ACTIVE, INACTIVE, DEPROVISIONING, and FAILED.

If a certificate has passed its expiration time, it's returned with a status of FAILED.

We recommend using pagination to ensure that the operation returns quickly and successfully. When there are more results than fit in a single response, the response includes a NextToken value that you use in a subsequent call to retrieve the next set of results.

Request Syntax


POST /v2/email/identity/certificates/list HTTP/1.1
Content-type: application/json

{
   "EmailIdentity": "string",
   "NextToken": "string",
   "PageSize": number
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

EmailIdentity

The email identity whose certificate associations you want to list.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

NextToken

A token returned from a previous call to ListEmailIdentityCertificates to indicate the position in the list of certificates.

Type: String

Required: No

PageSize

The number of results to show in a single call to ListEmailIdentityCertificates. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

Type: Integer

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Certificates": [ 
      { 
         "CertificateArn": "string",
         "CertificateExpiryTime": number,
         "FromAddress": "string",
         "Status": "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.

Certificates

An array that contains the certificate associations for the email identity. Each entry includes the from address, the certificate's status, its Amazon Resource Name (ARN), and its expiry time.

Type: Array of IdentityCertificate objects

NextToken

A token that indicates that there are additional certificates to list. To view additional certificates, issue another request to ListEmailIdentityCertificates, and pass this token in the NextToken parameter.

Type: String

Errors

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

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429