Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateAddonInstance

Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.

Request Syntax


{
   "AddonSubscriptionId": "string",
   "ClientToken": "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.

AddonSubscriptionId

The unique ID of a previously created subscription that an Add On instance is created for. You can only have one instance per subscription.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 67.

Pattern: ^as-[a-zA-Z0-9]{1,64}$

Required: Yes

ClientToken

A unique token that Amazon SES uses to recognize subsequent retries of the same request.

Type: String

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

Required: No

Tags

The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


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

AddonInstanceId

The unique ID of the Add On instance created by this API.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 67.

Pattern: ^ai-[a-zA-Z0-9]{1,64}$

Errors

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

ConflictException

The request configuration has conflicts. For details, see the accompanying error message.

HTTP Status Code: 400

ResourceNotFoundException

Occurs when a requested resource is not found.

HTTP Status Code: 400

ServiceQuotaExceededException

Occurs when an operation exceeds a predefined service quota or limit.

HTTP Status Code: 400

ValidationException

The request validation has failed. For details, see the accompanying error message.

HTTP Status Code: 400