CreateAddonSubscription
Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies.
Request Syntax
{
"AddonName": "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.
- AddonName
-
The name of the Add On to subscribe to. You can only have one subscription for each Add On name.
Type: String
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
{
"AddonSubscriptionId": "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.
- AddonSubscriptionId
-
The unique ID of the Add On subscription created by this API.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 67.
Pattern:
^as-[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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
