AWS SDK for C++AWS SDK for C++ Version 1.11.606 |
#include <NotificationsClient.h>
The Amazon Web Services User Notifications API Reference provides descriptions, API request parameters, and the JSON response for each of the User Notification API actions.
User Notification control plane APIs are currently available in US East (Virginia) - us-east-1
.
GetNotificationEvent and ListNotificationEvents APIs are currently available in commercial partition Regions and only return notifications stored in the same Region in which they're called.
The User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a notification hub in addition to US East (Virginia).
Definition at line 34 of file NotificationsClient.h.
Definition at line 37 of file NotificationsClient.h.
Definition at line 41 of file NotificationsClient.h.
Definition at line 42 of file NotificationsClient.h.
Aws::Notifications::NotificationsClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Notifications::NotificationsClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Notifications::NotificationsClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Associates a delivery Channel with a particular NotificationConfiguration
. Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).
nullptr
An Async wrapper for AssociateChannel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 116 of file NotificationsClient.h.
A Callable wrapper for AssociateChannel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 107 of file NotificationsClient.h.
Associates an Account Contact with a particular ManagedNotificationConfiguration
.
nullptr
An Async wrapper for AssociateManagedNotificationAccountContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 142 of file NotificationsClient.h.
A Callable wrapper for AssociateManagedNotificationAccountContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 133 of file NotificationsClient.h.
Associates an additional Channel with a particular ManagedNotificationConfiguration
.
Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).
nullptr
An Async wrapper for AssociateManagedNotificationAdditionalChannel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 170 of file NotificationsClient.h.
A Callable wrapper for AssociateManagedNotificationAdditionalChannel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 161 of file NotificationsClient.h.
Creates an EventRule
that is associated with a specified NotificationConfiguration
.
nullptr
An Async wrapper for CreateEventRule that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 198 of file NotificationsClient.h.
A Callable wrapper for CreateEventRule that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 189 of file NotificationsClient.h.
nullptr
An Async wrapper for CreateNotificationConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 224 of file NotificationsClient.h.
A Callable wrapper for CreateNotificationConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 215 of file NotificationsClient.h.
nullptr
An Async wrapper for DeleteEventRule that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 249 of file NotificationsClient.h.
A Callable wrapper for DeleteEventRule that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 240 of file NotificationsClient.h.
nullptr
An Async wrapper for DeleteNotificationConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 275 of file NotificationsClient.h.
A Callable wrapper for DeleteNotificationConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 266 of file NotificationsClient.h.
Deregisters a NotificationConfiguration
in the specified Region.
You can't deregister the last NotificationHub
in the account. NotificationEvents
stored in the deregistered NotificationConfiguration
are no longer be visible. Recreating a new NotificationConfiguration
in the same Region restores access to those NotificationEvents
.
nullptr
An Async wrapper for DeregisterNotificationHub that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 305 of file NotificationsClient.h.
A Callable wrapper for DeregisterNotificationHub that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 296 of file NotificationsClient.h.
{}
)
const
Disables service trust between User Notifications and Amazon Web Services Organizations.
nullptr
,
{}
An Async wrapper for DisableNotificationsAccessForOrganization that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 331 of file NotificationsClient.h.
{}
)
const
A Callable wrapper for DisableNotificationsAccessForOrganization that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 322 of file NotificationsClient.h.
Disassociates a Channel from a specified NotificationConfiguration
. Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).
nullptr
An Async wrapper for DisassociateChannel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 359 of file NotificationsClient.h.
A Callable wrapper for DisassociateChannel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 350 of file NotificationsClient.h.
Disassociates an Account Contact with a particular ManagedNotificationConfiguration
.
nullptr
An Async wrapper for DisassociateManagedNotificationAccountContact that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 385 of file NotificationsClient.h.
A Callable wrapper for DisassociateManagedNotificationAccountContact that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 376 of file NotificationsClient.h.
Disassociates an additional Channel from a particular ManagedNotificationConfiguration
.
Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).
nullptr
An Async wrapper for DisassociateManagedNotificationAdditionalChannel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 413 of file NotificationsClient.h.
A Callable wrapper for DisassociateManagedNotificationAdditionalChannel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 404 of file NotificationsClient.h.
{}
)
const
Enables service trust between User Notifications and Amazon Web Services Organizations.
nullptr
,
{}
An Async wrapper for EnableNotificationsAccessForOrganization that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 439 of file NotificationsClient.h.
{}
)
const
A Callable wrapper for EnableNotificationsAccessForOrganization that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 430 of file NotificationsClient.h.
nullptr
An Async wrapper for GetEventRule that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 464 of file NotificationsClient.h.
A Callable wrapper for GetEventRule that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 455 of file NotificationsClient.h.
nullptr
An Async wrapper for GetManagedNotificationChildEvent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 490 of file NotificationsClient.h.
A Callable wrapper for GetManagedNotificationChildEvent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 481 of file NotificationsClient.h.
nullptr
An Async wrapper for GetManagedNotificationConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 516 of file NotificationsClient.h.
A Callable wrapper for GetManagedNotificationConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 507 of file NotificationsClient.h.
nullptr
An Async wrapper for GetManagedNotificationEvent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 542 of file NotificationsClient.h.
A Callable wrapper for GetManagedNotificationEvent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 533 of file NotificationsClient.h.
nullptr
An Async wrapper for GetNotificationConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 568 of file NotificationsClient.h.
A Callable wrapper for GetNotificationConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 559 of file NotificationsClient.h.
Returns a specified NotificationEvent
.
User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. GetNotificationEvent
only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the Amazon Web Services User Notifications User Guide.
nullptr
An Async wrapper for GetNotificationEvent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 603 of file NotificationsClient.h.
A Callable wrapper for GetNotificationEvent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 594 of file NotificationsClient.h.
{}
)
const
Returns the AccessStatus of Service Trust Enablement for User Notifications and Amazon Web Services Organizations.
nullptr
,
{}
An Async wrapper for GetNotificationsAccessForOrganization that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 629 of file NotificationsClient.h.
{}
)
const
A Callable wrapper for GetNotificationsAccessForOrganization that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 620 of file NotificationsClient.h.
nullptr
An Async wrapper for ListChannels that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 655 of file NotificationsClient.h.
A Callable wrapper for ListChannels that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 646 of file NotificationsClient.h.
Returns a list of EventRules
according to specified filters, in reverse chronological order (newest first).
nullptr
An Async wrapper for ListEventRules that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 681 of file NotificationsClient.h.
A Callable wrapper for ListEventRules that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 672 of file NotificationsClient.h.
Returns a list of Account contacts and Channels associated with a ManagedNotificationConfiguration
, in paginated format.
nullptr
An Async wrapper for ListManagedNotificationChannelAssociations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 708 of file NotificationsClient.h.
A Callable wrapper for ListManagedNotificationChannelAssociations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 699 of file NotificationsClient.h.
Returns a list of ManagedNotificationChildEvents
for a specified aggregate ManagedNotificationEvent
, ordered by creation time in reverse chronological order (newest first).
nullptr
An Async wrapper for ListManagedNotificationChildEvents that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 735 of file NotificationsClient.h.
A Callable wrapper for ListManagedNotificationChildEvents that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 726 of file NotificationsClient.h.
{}
)
const
Returns a list of Managed Notification Configurations according to specified filters, ordered by creation time in reverse chronological order (newest first).
nullptr
,
{}
An Async wrapper for ListManagedNotificationConfigurations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 762 of file NotificationsClient.h.
{}
)
const
A Callable wrapper for ListManagedNotificationConfigurations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 753 of file NotificationsClient.h.
{}
)
const
Returns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first).
nullptr
,
{}
An Async wrapper for ListManagedNotificationEvents that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 789 of file NotificationsClient.h.
{}
)
const
A Callable wrapper for ListManagedNotificationEvents that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 780 of file NotificationsClient.h.
{}
)
const
Returns a list of abbreviated NotificationConfigurations
according to specified filters, in reverse chronological order (newest first).
nullptr
,
{}
An Async wrapper for ListNotificationConfigurations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 816 of file NotificationsClient.h.
{}
)
const
A Callable wrapper for ListNotificationConfigurations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 807 of file NotificationsClient.h.
{}
)
const
Returns a list of NotificationEvents
according to specified filters, in reverse chronological order (newest first).
User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the Amazon Web Services User Notifications User Guide.
nullptr
,
{}
An Async wrapper for ListNotificationEvents that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 852 of file NotificationsClient.h.
{}
)
const
A Callable wrapper for ListNotificationEvents that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 843 of file NotificationsClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListNotificationHubs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 878 of file NotificationsClient.h.
{}
)
const
A Callable wrapper for ListNotificationHubs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 869 of file NotificationsClient.h.
Returns a list of tags for a specified Amazon Resource Name (ARN).
For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.
This is only supported for NotificationConfigurations
.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 908 of file NotificationsClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 899 of file NotificationsClient.h.
nullptr
An Async wrapper for RegisterNotificationHub that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 936 of file NotificationsClient.h.
A Callable wrapper for RegisterNotificationHub that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 927 of file NotificationsClient.h.
Tags the resource with a tag key and value.
For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.
This is only supported for NotificationConfigurations
.
nullptr
An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 966 of file NotificationsClient.h.
A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 957 of file NotificationsClient.h.
Untags a resource with a specified Amazon Resource Name (ARN).
For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.
nullptr
An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 995 of file NotificationsClient.h.
A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 986 of file NotificationsClient.h.
nullptr
An Async wrapper for UpdateEventRule that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1020 of file NotificationsClient.h.
A Callable wrapper for UpdateEventRule that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1011 of file NotificationsClient.h.
nullptr
An Async wrapper for UpdateNotificationConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1046 of file NotificationsClient.h.
A Callable wrapper for UpdateNotificationConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1037 of file NotificationsClient.h.
Definition at line 1053 of file NotificationsClient.h.