Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeSubscribersForNotification

Lists the subscribers that are associated with a notification.

Request Syntax


{
   "AccountId": "string",
   "BudgetName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "Notification": { 
      "ComparisonOperator": "string",
      "NotificationState": "string",
      "NotificationType": "string",
      "Threshold": number,
      "ThresholdType": "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 accountId that is associated with the budget whose subscribers you want descriptions of.

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d{12}

Required: Yes

BudgetName

The name of the budget whose subscribers you want descriptions of.

Type: String

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

Pattern: ^(?![^:\\]*/action/|(?i).*<script>.*</script>.*)[^:\\]+$

Required: Yes

MaxResults

An optional integer that represents how many entries a paginated response contains.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2147483647.

Pattern: .*

Required: No

Notification

The notification whose subscribers you want to list.

Type: Notification object

Required: Yes

Response Syntax


{
   "NextToken": "string",
   "Subscribers": [ 
      { 
         "Address": "string",
         "SubscriptionType": "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.

NextToken

The pagination token in the service response that indicates the next set of results that you can retrieve.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2147483647.

Pattern: .*

Subscribers

A list of subscribers that are associated with a notification.

Type: Array of Subscriber objects

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

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.

Message: The error message the exception carries.

HTTP Status Code: 400

ExpiredNextTokenException

The pagination token expired.

Message: The error message the exception carries.

HTTP Status Code: 400

InternalErrorException

An error on the server occurred during the processing of your request. Try again later.

Message: The error message the exception carries.

HTTP Status Code: 400

InvalidNextTokenException

The pagination token is invalid.

Message: The error message the exception carries.

HTTP Status Code: 400

InvalidParameterException

An error on the client occurred. Typically, the cause is an invalid input value.

Message: The error message the exception carries.

HTTP Status Code: 400

NotFoundException

We can’t locate the resource that you specified.

Message: The error message the exception carries.

HTTP Status Code: 400

ThrottlingException

The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

Message: The error message the exception carries.

HTTP Status Code: 400

Examples

Example

The following is a sample request and response of the DescribeSubscribersForNotification 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.DescribeSubscribersForNotification
{
   "AccountId": "111122223333",
   "BudgetName": "Example Budget",
   "MaxResults": 5,
   "Notification": { 
      "ComparisonOperator": "GREATER_THAN",
      "NotificationType": "ACTUAL",
      "Threshold": 80,
      "ThresholdType": "PERCENTAGE"
    }
}

Sample Response


{
   "NextToken": "string",
   "Subscribers": [ 
      { 
           "Address": "example@example.com",
           "SubscriptionType": "EMAIL"
      }
   ]
}