amazonka-neptune-2.0: Amazon Neptune SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Neptune.ModifyEventSubscription

Description

Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.

Synopsis

Creating a Request

data ModifyEventSubscription Source #

See: newModifyEventSubscription smart constructor.

Constructors

ModifyEventSubscription' 

Fields

  • enabled :: Maybe Bool

    A Boolean value; set to true to activate the subscription.

  • eventCategories :: Maybe [Text]

    A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.

  • snsTopicArn :: Maybe Text

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

  • sourceType :: Maybe Text

    The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

  • subscriptionName :: Text

    The name of the event notification subscription.

Instances

Instances details
ToHeaders ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Methods

toHeaders :: ModifyEventSubscription -> [Header] #

ToPath ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Methods

toPath :: ModifyEventSubscription -> ByteString #

ToQuery ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Methods

toQuery :: ModifyEventSubscription -> QueryString #

AWSRequest ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Associated Types

type AWSResponse ModifyEventSubscription #

Methods

request :: (Service -> Service) -> ModifyEventSubscription -> Request ModifyEventSubscription #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyEventSubscription -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyEventSubscription))) #

Generic ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Associated Types

type Rep ModifyEventSubscription :: Type -> Type #

Methods

from :: ModifyEventSubscription -> Rep ModifyEventSubscription x #

to :: Rep ModifyEventSubscription x -> ModifyEventSubscription #

Read ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Methods

readsPrec :: Int -> ReadS ModifyEventSubscription #

readList :: ReadS [ModifyEventSubscription] #

readPrec :: ReadPrec ModifyEventSubscription #

readListPrec :: ReadPrec [ModifyEventSubscription] #

Show ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Methods

showsPrec :: Int -> ModifyEventSubscription -> ShowS #

show :: ModifyEventSubscription -> String #

showList :: [ModifyEventSubscription] -> ShowS #

NFData ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Methods

rnf :: ModifyEventSubscription -> () #

Eq ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Methods

(==) :: ModifyEventSubscription -> ModifyEventSubscription -> Bool #

(/=) :: ModifyEventSubscription -> ModifyEventSubscription -> Bool #

Hashable ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Methods

hashWithSalt :: Int -> ModifyEventSubscription -> Int #

hash :: ModifyEventSubscription -> Int #

type AWSResponse ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

type AWSResponse ModifyEventSubscription = ModifyEventSubscriptionResponse
type Rep ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

type Rep ModifyEventSubscription = D1 ('MetaData "ModifyEventSubscription" "Amazonka.Neptune.ModifyEventSubscription" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "ModifyEventSubscription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "eventCategories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subscriptionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newModifyEventSubscription Source #

Arguments

:: Text

$sel:subscriptionName:ModifyEventSubscription'

-> ModifyEventSubscription 

Create a value of ModifyEventSubscription 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:

ModifyEventSubscription, modifyEventSubscription_enabled - A Boolean value; set to true to activate the subscription.

ModifyEventSubscription, modifyEventSubscription_eventCategories - A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.

ModifyEventSubscription, modifyEventSubscription_snsTopicArn - The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

ModifyEventSubscription, modifyEventSubscription_sourceType - The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

$sel:subscriptionName:ModifyEventSubscription', modifyEventSubscription_subscriptionName - The name of the event notification subscription.

Request Lenses

modifyEventSubscription_enabled :: Lens' ModifyEventSubscription (Maybe Bool) Source #

A Boolean value; set to true to activate the subscription.

modifyEventSubscription_eventCategories :: Lens' ModifyEventSubscription (Maybe [Text]) Source #

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.

modifyEventSubscription_snsTopicArn :: Lens' ModifyEventSubscription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

modifyEventSubscription_sourceType :: Lens' ModifyEventSubscription (Maybe Text) Source #

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

modifyEventSubscription_subscriptionName :: Lens' ModifyEventSubscription Text Source #

The name of the event notification subscription.

Destructuring the Response

data ModifyEventSubscriptionResponse Source #

See: newModifyEventSubscriptionResponse smart constructor.

Constructors

ModifyEventSubscriptionResponse' 

Fields

Instances

Instances details
Generic ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Associated Types

type Rep ModifyEventSubscriptionResponse :: Type -> Type #

Methods

from :: ModifyEventSubscriptionResponse -> Rep ModifyEventSubscriptionResponse x #

to :: Rep ModifyEventSubscriptionResponse x -> ModifyEventSubscriptionResponse #

Read ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Methods

readsPrec :: Int -> ReadS ModifyEventSubscriptionResponse #

readList :: ReadS [ModifyEventSubscriptionResponse] #

readPrec :: ReadPrec ModifyEventSubscriptionResponse #

readListPrec :: ReadPrec [ModifyEventSubscriptionResponse] #

Show ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Methods

showsPrec :: Int -> ModifyEventSubscriptionResponse -> ShowS #

show :: ModifyEventSubscriptionResponse -> String #

showList :: [ModifyEventSubscriptionResponse] -> ShowS #

NFData ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Methods

rnf :: ModifyEventSubscriptionResponse -> () #

Eq ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Methods

(==) :: ModifyEventSubscriptionResponse -> ModifyEventSubscriptionResponse -> Bool #

(/=) :: ModifyEventSubscriptionResponse -> ModifyEventSubscriptionResponse -> Bool #

type Rep ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

type Rep ModifyEventSubscriptionResponse = D1 ('MetaData "ModifyEventSubscriptionResponse" "Amazonka.Neptune.ModifyEventSubscription" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "ModifyEventSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSubscription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyEventSubscriptionResponse Source #

Arguments

:: Int

$sel:httpStatus:ModifyEventSubscriptionResponse'

-> ModifyEventSubscriptionResponse 

Create a value of ModifyEventSubscriptionResponse 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:eventSubscription:ModifyEventSubscriptionResponse', modifyEventSubscriptionResponse_eventSubscription - Undocumented member.

$sel:httpStatus:ModifyEventSubscriptionResponse', modifyEventSubscriptionResponse_httpStatus - The response's http status code.

Response Lenses

modifyEventSubscriptionResponse_eventSubscription :: Lens' ModifyEventSubscriptionResponse (Maybe EventSubscription) Source #

Undocumented member.

modifyEventSubscriptionResponse_httpStatus :: Lens' ModifyEventSubscriptionResponse Int Source #

The response's http status code.