Redshift / Client / modify_event_subscription

modify_event_subscription

Redshift.Client.modify_event_subscription(**kwargs)

Modifies an existing Amazon Redshift event notification subscription.

See also: AWS API Documentation

Request Syntax

response = client.modify_event_subscription(
    SubscriptionName='string',
    SnsTopicArn='string',
    SourceType='string',
    SourceIds=[
        'string',
    ],
    EventCategories=[
        'string',
    ],
    Severity='string',
    Enabled=True|False
)

Parameters:

• SubscriptionName (string) –

  [REQUIRED]

  The name of the modified Amazon Redshift event notification subscription.

• SnsTopicArn (string) – The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.

• SourceType (string) –

  The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your Amazon Web Services account. You must specify a source type in order to specify source IDs.

  Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

• SourceIds (list) –

  A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

  Example: my-cluster-1, my-cluster-2

  Example: my-snapshot-20131010

  • (string) –

• EventCategories (list) –

  Specifies the Amazon Redshift event categories to be published by the event notification subscription.

  Values: configuration, management, monitoring, security, pending

  • (string) –

• Severity (string) –

  Specifies the Amazon Redshift event severity to be published by the event notification subscription.

  Values: ERROR, INFO

• Enabled (boolean) – A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled

Return type:

dict

Returns:

Response Syntax

{
    'EventSubscription': {
        'CustomerAwsId': 'string',
        'CustSubscriptionId': 'string',
        'SnsTopicArn': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': datetime(2015, 1, 1),
        'SourceType': 'string',
        'SourceIdsList': [
            'string',
        ],
        'EventCategoriesList': [
            'string',
        ],
        'Severity': 'string',
        'Enabled': True|False,
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • EventSubscription (dict) –

    Describes event subscriptions.

    • CustomerAwsId (string) –

      The Amazon Web Services account associated with the Amazon Redshift event notification subscription.

    • CustSubscriptionId (string) –

      The name of the Amazon Redshift event notification subscription.

    • SnsTopicArn (string) –

      The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

    • Status (string) –

      The status of the Amazon Redshift event notification subscription.

      Constraints:

      • Can be one of the following: active | no-permission | topic-not-exist

      • The status “no-permission” indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status “topic-not-exist” indicates that the topic was deleted after the subscription was created.

    • SubscriptionCreationTime (datetime) –

      The date and time the Amazon Redshift event notification subscription was created.

    • SourceType (string) –

      The source type of the events returned by the Amazon Redshift event notification, such as cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action.

    • SourceIdsList (list) –

      A list of the sources that publish events to the Amazon Redshift event notification subscription.

      • (string) –

    • EventCategoriesList (list) –

      The list of Amazon Redshift event categories specified in the event notification subscription.

      Values: Configuration, Management, Monitoring, Security, Pending

      • (string) –

    • Severity (string) –

      The event severity specified in the Amazon Redshift event notification subscription.

      Values: ERROR, INFO

    • Enabled (boolean) –

      A boolean value indicating whether the subscription is enabled; true indicates that the subscription is enabled.

    • Tags (list) –

      The list of tags for the event subscription.

      • (dict) –

        A tag consisting of a name/value pair for a resource.

        • Key (string) –

          The key, or name, for the resource tag.

        • Value (string) –

          The value for the resource tag.

Exceptions

• Redshift.Client.exceptions.SubscriptionNotFoundFault

• Redshift.Client.exceptions.SNSInvalidTopicFault

• Redshift.Client.exceptions.SNSNoAuthorizationFault

• Redshift.Client.exceptions.SNSTopicArnNotFoundFault

• Redshift.Client.exceptions.SubscriptionEventIdNotFoundFault

• Redshift.Client.exceptions.SubscriptionCategoryNotFoundFault

• Redshift.Client.exceptions.SubscriptionSeverityNotFoundFault

• Redshift.Client.exceptions.SourceNotFoundFault

• Redshift.Client.exceptions.InvalidSubscriptionStateFault