Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateAcmeExternalAccountBinding

Creates an external account binding (EAB) for an ACME endpoint. An EAB provides credentials that authorize an ACME client to register an account with the endpoint. Each EAB is associated with an IAM role that controls what certificate operations the ACME client can perform.

Request Syntax


{
   "AcmeEndpointArn": "string",
   "Expiration": { 
      "Type": "string",
      "Value": number
   },
   "IdempotencyToken": "string",
   "RoleArn": "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.

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

RoleArn

The Amazon Resource Name (ARN) of the IAM role to associate with the external account binding.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws[a-z-]*:iam::[0-9]{12}:role/.+

Required: Yes

Expiration

The expiration configuration for the external account binding.

Type: Expiration object

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 external account binding.

Type: Array of Tag objects

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

Required: No

Response Syntax


{
   "ExternalAccountBinding": { 
      "AcmeEndpointArn": "string",
      "AcmeExternalAccountBindingArn": "string",
      "CreatedAt": number,
      "ExpiresAt": number,
      "LastUsedAt": number,
      "RevokedAt": number,
      "RoleArn": "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.

ExternalAccountBinding

The created external account binding.

Type: AcmeExternalAccountBinding 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

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

ResourceNotFoundException

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

HTTP Status Code: 400

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