CreateSubscriber
Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
Request Syntax
{
"AccountId": "string",
"BudgetName": "string",
"Notification": {
"ComparisonOperator": "string",
"NotificationState": "string",
"NotificationType": "string",
"Threshold": number,
"ThresholdType": "string"
},
"Subscriber": {
"Address": "string",
"SubscriptionType": "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.
- AccountId
-
The
accountIdthat is associated with the budget that you want to create a subscriber for.Type: String
Length Constraints: Fixed length of 12.
Pattern:
\d{12}Required: Yes
- BudgetName
-
The name of the budget that you want to subscribe to. Budget names must be unique within an account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^(?![^:\\]*/action/|(?i).*<script>.*</script>.*)[^:\\]+$Required: Yes
- Notification
-
The notification that you want to create a subscriber for.
Type: Notification object
Required: Yes
- Subscriber
-
The subscriber that you want to associate with a budget notification.
Type: Subscriber object
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to use this operation with the given parameters.
HTTP Status Code: 400
- CreationLimitExceededException
-
You've exceeded the notification or subscriber limit.
HTTP Status Code: 400
- DuplicateRecordException
-
The budget name already exists. Budget names must be unique within an account.
HTTP Status Code: 400
- InternalErrorException
-
An error on the server occurred during the processing of your request. Try again later.
HTTP Status Code: 400
- InvalidParameterException
-
An error on the client occurred. Typically, the cause is an invalid input value.
HTTP Status Code: 400
- NotFoundException
-
We can’t locate the resource that you specified.
HTTP Status Code: 400
- ThrottlingException
-
The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
HTTP Status Code: 400
Examples
Example
The following is a sample request of the CreateSubscriber operation.
Sample Request
POST / HTTP/1.1
Host: awsbudgets.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=contenttype;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid,Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AWSBudgetServiceGateway.CreateSubscriber
{
"AccountId": "111122223333",
"BudgetName": "Example Budget",
"Notification": {
"ComparisonOperator": "GREATER_THAN",
"NotificationType": "ACTUAL",
"Threshold": 80,
"ThresholdType": "PERCENTAGE"
},
"Subscribers": [
{
"Address": "example@example.com",
"SubscriptionType": "EMAIL"
}
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
