- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeEventSubscriptionsCommand
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner
and environment
for tag keys, and admin
and test
for tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { RedshiftClient, DescribeEventSubscriptionsCommand } from "@aws-sdk/client-redshift"; // ES Modules import
// const { RedshiftClient, DescribeEventSubscriptionsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import
const client = new RedshiftClient(config);
const input = { // DescribeEventSubscriptionsMessage
SubscriptionName: "STRING_VALUE",
MaxRecords: Number("int"),
Marker: "STRING_VALUE",
TagKeys: [ // TagKeyList
"STRING_VALUE",
],
TagValues: [ // TagValueList
"STRING_VALUE",
],
};
const command = new DescribeEventSubscriptionsCommand(input);
const response = await client.send(command);
// { // EventSubscriptionsMessage
// Marker: "STRING_VALUE",
// EventSubscriptionsList: [ // EventSubscriptionsList
// { // EventSubscription
// CustomerAwsId: "STRING_VALUE",
// CustSubscriptionId: "STRING_VALUE",
// SnsTopicArn: "STRING_VALUE",
// Status: "STRING_VALUE",
// SubscriptionCreationTime: new Date("TIMESTAMP"),
// SourceType: "STRING_VALUE",
// SourceIdsList: [ // SourceIdsList
// "STRING_VALUE",
// ],
// EventCategoriesList: [ // EventCategoriesList
// "STRING_VALUE",
// ],
// Severity: "STRING_VALUE",
// Enabled: true || false,
// Tags: [ // TagList
// { // Tag
// Key: "STRING_VALUE",
// Value: "STRING_VALUE",
// },
// ],
// },
// ],
// };
DescribeEventSubscriptionsCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
Marker | string | undefined | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in |
MaxRecords | number | undefined | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified Default: Constraints: minimum 20, maximum 100. |
SubscriptionName | string | undefined | The name of the Amazon Redshift event notification subscription to be described. |
TagKeys | string[] | undefined | A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called |
TagValues | string[] | undefined | A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions that are tagged with values called |
DescribeEventSubscriptionsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
EventSubscriptionsList | EventSubscription[] | undefined | A list of event subscriptions. |
Marker | string | undefined | A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InvalidTagFault | client | The tag is invalid. |
SubscriptionNotFoundFault | client | An Amazon Redshift event notification subscription with the specified name does not exist. |
RedshiftServiceException | Base exception class for all service exceptions from Redshift service. |