| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Budgets.DescribeSubscribersForNotification
Description
Lists the subscribers that are associated with a notification.
This operation returns paginated results.
Synopsis
- data DescribeSubscribersForNotification = DescribeSubscribersForNotification' {}
- newDescribeSubscribersForNotification :: Text -> Text -> Notification -> DescribeSubscribersForNotification
- describeSubscribersForNotification_nextToken :: Lens' DescribeSubscribersForNotification (Maybe Text)
- describeSubscribersForNotification_maxResults :: Lens' DescribeSubscribersForNotification (Maybe Natural)
- describeSubscribersForNotification_accountId :: Lens' DescribeSubscribersForNotification Text
- describeSubscribersForNotification_budgetName :: Lens' DescribeSubscribersForNotification Text
- describeSubscribersForNotification_notification :: Lens' DescribeSubscribersForNotification Notification
- data DescribeSubscribersForNotificationResponse = DescribeSubscribersForNotificationResponse' {
- nextToken :: Maybe Text
- subscribers :: Maybe (NonEmpty Subscriber)
- httpStatus :: Int
- newDescribeSubscribersForNotificationResponse :: Int -> DescribeSubscribersForNotificationResponse
- describeSubscribersForNotificationResponse_nextToken :: Lens' DescribeSubscribersForNotificationResponse (Maybe Text)
- describeSubscribersForNotificationResponse_subscribers :: Lens' DescribeSubscribersForNotificationResponse (Maybe (NonEmpty Subscriber))
- describeSubscribersForNotificationResponse_httpStatus :: Lens' DescribeSubscribersForNotificationResponse Int
Creating a Request
data DescribeSubscribersForNotification Source #
Request of DescribeSubscribersForNotification
See: newDescribeSubscribersForNotification smart constructor.
Constructors
| DescribeSubscribersForNotification' | |
Fields
| |
Instances
newDescribeSubscribersForNotification Source #
Arguments
| :: Text | |
| -> Text | |
| -> Notification | |
| -> DescribeSubscribersForNotification |
Create a value of DescribeSubscribersForNotification with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeSubscribersForNotification', describeSubscribersForNotification_nextToken - The pagination token that you include in your request to indicate the
next set of results that you want to retrieve.
$sel:maxResults:DescribeSubscribersForNotification', describeSubscribersForNotification_maxResults - An optional integer that represents how many entries a paginated
response contains. The maximum is 100.
$sel:accountId:DescribeSubscribersForNotification', describeSubscribersForNotification_accountId - The accountId that is associated with the budget whose subscribers you
want descriptions of.
$sel:budgetName:DescribeSubscribersForNotification', describeSubscribersForNotification_budgetName - The name of the budget whose subscribers you want descriptions of.
$sel:notification:DescribeSubscribersForNotification', describeSubscribersForNotification_notification - The notification whose subscribers you want to list.
Request Lenses
describeSubscribersForNotification_nextToken :: Lens' DescribeSubscribersForNotification (Maybe Text) Source #
The pagination token that you include in your request to indicate the next set of results that you want to retrieve.
describeSubscribersForNotification_maxResults :: Lens' DescribeSubscribersForNotification (Maybe Natural) Source #
An optional integer that represents how many entries a paginated response contains. The maximum is 100.
describeSubscribersForNotification_accountId :: Lens' DescribeSubscribersForNotification Text Source #
The accountId that is associated with the budget whose subscribers you
want descriptions of.
describeSubscribersForNotification_budgetName :: Lens' DescribeSubscribersForNotification Text Source #
The name of the budget whose subscribers you want descriptions of.
describeSubscribersForNotification_notification :: Lens' DescribeSubscribersForNotification Notification Source #
The notification whose subscribers you want to list.
Destructuring the Response
data DescribeSubscribersForNotificationResponse Source #
Response of DescribeSubscribersForNotification
See: newDescribeSubscribersForNotificationResponse smart constructor.
Constructors
| DescribeSubscribersForNotificationResponse' | |
Fields
| |
Instances
newDescribeSubscribersForNotificationResponse Source #
Arguments
| :: Int | |
| -> DescribeSubscribersForNotificationResponse |
Create a value of DescribeSubscribersForNotificationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeSubscribersForNotification', describeSubscribersForNotificationResponse_nextToken - The pagination token in the service response that indicates the next set
of results that you can retrieve.
$sel:subscribers:DescribeSubscribersForNotificationResponse', describeSubscribersForNotificationResponse_subscribers - A list of subscribers that are associated with a notification.
$sel:httpStatus:DescribeSubscribersForNotificationResponse', describeSubscribersForNotificationResponse_httpStatus - The response's http status code.
Response Lenses
describeSubscribersForNotificationResponse_nextToken :: Lens' DescribeSubscribersForNotificationResponse (Maybe Text) Source #
The pagination token in the service response that indicates the next set of results that you can retrieve.
describeSubscribersForNotificationResponse_subscribers :: Lens' DescribeSubscribersForNotificationResponse (Maybe (NonEmpty Subscriber)) Source #
A list of subscribers that are associated with a notification.
describeSubscribersForNotificationResponse_httpStatus :: Lens' DescribeSubscribersForNotificationResponse Int Source #
The response's http status code.