Network.AWS.WorkDocs.CreateNotificationSubscription

Configure WorkDocs to use Amazon SNS notifications.

The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Confirm the Subscription in the Amazon Simple Notification Service Developer Guide .

Creating a Request

createNotificationSubscription

Arguments

:: Text

cnsOrganizationId

-> Text

cnsEndpoint

-> SubscriptionProtocolType

cnsProtocol

-> SubscriptionType

cnsSubscriptionType

-> CreateNotificationSubscription

Creates a value of CreateNotificationSubscription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cnsOrganizationId - The ID of the organization.
• cnsEndpoint - The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with "https://".
• cnsProtocol - The protocol to use. The supported value is https, which delivers JSON-encoded messasges using HTTPS POST.
• cnsSubscriptionType - The notification type.

data CreateNotificationSubscription

See: createNotificationSubscription smart constructor.

Instances

Eq CreateNotificationSubscription

Methods

(==) :: CreateNotificationSubscription -> CreateNotificationSubscription -> Bool

(/=) :: CreateNotificationSubscription -> CreateNotificationSubscription -> Bool

Data CreateNotificationSubscription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateNotificationSubscription -> c CreateNotificationSubscription

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateNotificationSubscription

toConstr :: CreateNotificationSubscription -> Constr

dataTypeOf :: CreateNotificationSubscription -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateNotificationSubscription)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateNotificationSubscription)

gmapT :: (forall b. Data b => b -> b) -> CreateNotificationSubscription -> CreateNotificationSubscription

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateNotificationSubscription -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateNotificationSubscription -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateNotificationSubscription -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateNotificationSubscription -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateNotificationSubscription -> m CreateNotificationSubscription

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateNotificationSubscription -> m CreateNotificationSubscription

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateNotificationSubscription -> m CreateNotificationSubscription

Read CreateNotificationSubscription

Methods

readsPrec :: Int -> ReadS CreateNotificationSubscription

readList :: ReadS [CreateNotificationSubscription]

readPrec :: ReadPrec CreateNotificationSubscription

readListPrec :: ReadPrec [CreateNotificationSubscription]

Show CreateNotificationSubscription

Methods

showsPrec :: Int -> CreateNotificationSubscription -> ShowS

show :: CreateNotificationSubscription -> String

showList :: [CreateNotificationSubscription] -> ShowS

Generic CreateNotificationSubscription

Associated Types

type Rep CreateNotificationSubscription :: * -> *

Methods

from :: CreateNotificationSubscription -> Rep CreateNotificationSubscription x

to :: Rep CreateNotificationSubscription x -> CreateNotificationSubscription

Hashable CreateNotificationSubscription

Methods

hashWithSalt :: Int -> CreateNotificationSubscription -> Int

hash :: CreateNotificationSubscription -> Int

ToJSON CreateNotificationSubscription

Methods

toJSON :: CreateNotificationSubscription -> Value

toEncoding :: CreateNotificationSubscription -> Encoding

toJSONList :: [CreateNotificationSubscription] -> Value

toEncodingList :: [CreateNotificationSubscription] -> Encoding

NFData CreateNotificationSubscription

Methods

rnf :: CreateNotificationSubscription -> ()

AWSRequest CreateNotificationSubscription

Associated Types

type Rs CreateNotificationSubscription :: *

Methods

request :: CreateNotificationSubscription -> Request CreateNotificationSubscription

response :: MonadResource m => Logger -> Service -> Proxy * CreateNotificationSubscription -> ClientResponse -> m (Response CreateNotificationSubscription)

ToQuery CreateNotificationSubscription

Methods

toQuery :: CreateNotificationSubscription -> QueryString

ToPath CreateNotificationSubscription

Methods

toPath :: CreateNotificationSubscription -> ByteString

ToHeaders CreateNotificationSubscription

Methods

toHeaders :: CreateNotificationSubscription -> [Header]

type Rep CreateNotificationSubscription

type Rep CreateNotificationSubscription = D1 (MetaData "CreateNotificationSubscription" "Network.AWS.WorkDocs.CreateNotificationSubscription" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "CreateNotificationSubscription'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cnsOrganizationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cnsEndpoint") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cnsProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SubscriptionProtocolType)) (S1 (MetaSel (Just Symbol "_cnsSubscriptionType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SubscriptionType)))))

type Rs CreateNotificationSubscription

type Rs CreateNotificationSubscription = CreateNotificationSubscriptionResponse

Request Lenses

cnsOrganizationId :: Lens' CreateNotificationSubscription Text

The ID of the organization.

cnsEndpoint :: Lens' CreateNotificationSubscription Text

The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with "https://".

cnsProtocol :: Lens' CreateNotificationSubscription SubscriptionProtocolType

The protocol to use. The supported value is https, which delivers JSON-encoded messasges using HTTPS POST.

cnsSubscriptionType :: Lens' CreateNotificationSubscription SubscriptionType

The notification type.

Destructuring the Response

createNotificationSubscriptionResponse

Arguments

:: Int

cnsrsResponseStatus

-> CreateNotificationSubscriptionResponse

Creates a value of CreateNotificationSubscriptionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cnsrsSubscription - The subscription.
• cnsrsResponseStatus - -- | The response status code.

data CreateNotificationSubscriptionResponse

See: createNotificationSubscriptionResponse smart constructor.

Instances

Eq CreateNotificationSubscriptionResponse

Methods

(==) :: CreateNotificationSubscriptionResponse -> CreateNotificationSubscriptionResponse -> Bool

(/=) :: CreateNotificationSubscriptionResponse -> CreateNotificationSubscriptionResponse -> Bool

Data CreateNotificationSubscriptionResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateNotificationSubscriptionResponse -> c CreateNotificationSubscriptionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateNotificationSubscriptionResponse

toConstr :: CreateNotificationSubscriptionResponse -> Constr

dataTypeOf :: CreateNotificationSubscriptionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateNotificationSubscriptionResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateNotificationSubscriptionResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateNotificationSubscriptionResponse -> CreateNotificationSubscriptionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateNotificationSubscriptionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateNotificationSubscriptionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateNotificationSubscriptionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateNotificationSubscriptionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateNotificationSubscriptionResponse -> m CreateNotificationSubscriptionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateNotificationSubscriptionResponse -> m CreateNotificationSubscriptionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateNotificationSubscriptionResponse -> m CreateNotificationSubscriptionResponse

Read CreateNotificationSubscriptionResponse

Methods

readsPrec :: Int -> ReadS CreateNotificationSubscriptionResponse

readList :: ReadS [CreateNotificationSubscriptionResponse]

readPrec :: ReadPrec CreateNotificationSubscriptionResponse

readListPrec :: ReadPrec [CreateNotificationSubscriptionResponse]

Show CreateNotificationSubscriptionResponse

Methods

showsPrec :: Int -> CreateNotificationSubscriptionResponse -> ShowS

show :: CreateNotificationSubscriptionResponse -> String

showList :: [CreateNotificationSubscriptionResponse] -> ShowS

Generic CreateNotificationSubscriptionResponse

Associated Types

type Rep CreateNotificationSubscriptionResponse :: * -> *

Methods

from :: CreateNotificationSubscriptionResponse -> Rep CreateNotificationSubscriptionResponse x

to :: Rep CreateNotificationSubscriptionResponse x -> CreateNotificationSubscriptionResponse

NFData CreateNotificationSubscriptionResponse

Methods

rnf :: CreateNotificationSubscriptionResponse -> ()

type Rep CreateNotificationSubscriptionResponse

type Rep CreateNotificationSubscriptionResponse = D1 (MetaData "CreateNotificationSubscriptionResponse" "Network.AWS.WorkDocs.CreateNotificationSubscription" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "CreateNotificationSubscriptionResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cnsrsSubscription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Subscription))) (S1 (MetaSel (Just Symbol "_cnsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

cnsrsSubscription :: Lens' CreateNotificationSubscriptionResponse (Maybe Subscription)

The subscription.

cnsrsResponseStatus :: Lens' CreateNotificationSubscriptionResponse Int

• - | The response status code.