DescribeAcmeEndpoint
Returns detailed metadata about the specified ACME endpoint, including its status, URL, authorization behavior, and certificate authority configuration.
Request Syntax
{
"AcmeEndpointArn": "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.
- AcmeEndpointArn
-
The Amazon Resource Name (ARN) of the ACME endpoint.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+Required: Yes
Response Syntax
{
"AcmeEndpoint": {
"AcmeEndpointArn": "string",
"AuthorizationBehavior": "string",
"CertificateAuthority": { ... },
"CertificateTags": [
{
"Key": "string",
"Value": "string"
}
],
"Contact": "string",
"CreatedAt": number,
"EndpointUrl": "string",
"FailureReason": "string",
"Status": "string",
"UpdatedAt": number
}
}
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.
- AcmeEndpoint
-
The ACME endpoint details.
Type: AcmeEndpoint object
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
- ResourceNotFoundException
-
The specified certificate cannot be found in the caller's account or the caller's account cannot be found.
HTTP Status Code: 400
- 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: