View a markdown version of this page

ListAcmeEndpoints - AWS Certificate Manager

ListAcmeEndpoints

Retrieves a list of ACME endpoints in your account. Use this operation to view all configured ACME endpoints and their current status.

Request Syntax

{ "MaxResults": 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.

MaxResults

The maximum number of results to return.

Type: Integer

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

Required: No

NextToken

A token for pagination.

Type: String

Required: No

Response Syntax

{ "AcmeEndpoints": [ { "AcmeEndpointArn": "string", "AuthorizationBehavior": "string", "CertificateAuthority": { ... }, "CertificateTags": [ { "Key": "string", "Value": "string" } ], "Contact": "string", "CreatedAt": number, "EndpointUrl": "string", "FailureReason": "string", "Status": "string", "UpdatedAt": number } ], "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.

AcmeEndpoints

The list of ACME endpoints.

Type: Array of AcmeEndpointSummary objects

NextToken

A token for pagination.

Type: String

Errors

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

AccessDeniedException

You do not have access required to perform this action.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ThrottlingException

The request was denied because it exceeded a quota.

throttlingReasons

One or more reasons why the request was throttled.

HTTP Status Code: 400

ValidationException

The supplied input failed to satisfy constraints of an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: