AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.

If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your Amazon Web Services account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your Amazon Web Services account. You must specify a source type if you specify a source ID.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateEventSubscription and EndCreateEventSubscription.

Namespace: Amazon.Redshift
Assembly: AWSSDK.Redshift.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<CreateEventSubscriptionResponse> CreateEventSubscriptionAsync(
         CreateEventSubscriptionRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Redshift.Model.CreateEventSubscriptionRequest

Container for the necessary parameters to execute the CreateEventSubscription service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CreateEventSubscription service method, as returned by Redshift.

Exceptions

ExceptionCondition
EventSubscriptionQuotaExceededException The request would exceed the allowed number of event subscriptions for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
InvalidTagException The tag is invalid.
SNSInvalidTopicException Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.
SNSNoAuthorizationException You do not have permission to publish to the specified Amazon SNS topic.
SNSTopicArnNotFoundException An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.
SourceNotFoundException The specified Amazon Redshift event source could not be found.
SubscriptionAlreadyExistException There is already an existing event notification subscription with the specified name.
SubscriptionCategoryNotFoundException The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.
SubscriptionEventIdNotFoundException An Amazon Redshift event with the specified event ID does not exist.
SubscriptionSeverityNotFoundException The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.
TagLimitExceededException You have exceeded the number of tags allowed.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also