Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateAcmeEndpoint

Creates an ACME endpoint, which is a managed ACME server with a unique endpoint URL. After creation, ACME clients can use the endpoint URL to automate certificate issuance using the ACME protocol.

Request Syntax


{
   "AuthorizationBehavior": "string",
   "CertificateAuthority": { ... },
   "CertificateTags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Contact": "string",
   "IdempotencyToken": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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.

AuthorizationBehavior

The authorization behavior for the ACME endpoint.

Type: String

Valid Values: PRE_APPROVED

Required: Yes

CertificateAuthority

The type of certificate authority to use for issuing certificates through this ACME endpoint.

Type: CertificateAuthority object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

CertificateTags

Tags to apply to certificates issued through this ACME endpoint.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Contact

Specifies whether ACME clients must provide contact information during account registration.

Type: String

Valid Values: REQUIRED | NOT_REQUIRED

Required: No

IdempotencyToken

A unique, case-sensitive identifier to ensure idempotency of the request.

Type: String

Required: No

Tags

One or more tags to associate with the ACME endpoint.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax


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

AcmeEndpointArn

The Amazon Resource Name (ARN) of the created 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-]+

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

ConflictException

You are trying to update a resource or configuration that is already being created or updated. Wait for the previous operation to finish and try again.

HTTP Status Code: 400

InternalServerException

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

HTTP Status Code: 500

ServiceQuotaExceededException

A service quota has been exceeded.

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