amazonka-workdocs-2.0: Amazon WorkDocs 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.WorkDocs.CreateNotificationSubscription

Description

Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.

For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.

Synopsis

Creating a Request

data CreateNotificationSubscription Source #

See: newCreateNotificationSubscription smart constructor.

Constructors

CreateNotificationSubscription' 

Fields

Instances

Instances details
ToJSON CreateNotificationSubscription Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Methods

toJSON :: CreateNotificationSubscription -> Value #

toEncoding :: CreateNotificationSubscription -> Encoding #

toJSONList :: [CreateNotificationSubscription] -> Value #

toEncodingList :: [CreateNotificationSubscription] -> Encoding #

ToHeaders CreateNotificationSubscription Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Methods

toHeaders :: CreateNotificationSubscription -> [Header] #

ToPath CreateNotificationSubscription Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Methods

toPath :: CreateNotificationSubscription -> ByteString #

ToQuery CreateNotificationSubscription Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Methods

toQuery :: CreateNotificationSubscription -> QueryString #

AWSRequest CreateNotificationSubscription Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Associated Types

type AWSResponse CreateNotificationSubscription #

Methods

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

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

Generic CreateNotificationSubscription Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Associated Types

type Rep CreateNotificationSubscription :: Type -> Type #

Methods

from :: CreateNotificationSubscription -> Rep CreateNotificationSubscription x #

to :: Rep CreateNotificationSubscription x -> CreateNotificationSubscription #

Read CreateNotificationSubscription Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Methods

readsPrec :: Int -> ReadS CreateNotificationSubscription #

readList :: ReadS [CreateNotificationSubscription] #

readPrec :: ReadPrec CreateNotificationSubscription #

readListPrec :: ReadPrec [CreateNotificationSubscription] #

Show CreateNotificationSubscription Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Methods

showsPrec :: Int -> CreateNotificationSubscription -> ShowS #

show :: CreateNotificationSubscription -> String #

showList :: [CreateNotificationSubscription] -> ShowS #

NFData CreateNotificationSubscription Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Methods

rnf :: CreateNotificationSubscription -> () #

Eq CreateNotificationSubscription Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Methods

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

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

Hashable CreateNotificationSubscription Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Methods

hashWithSalt :: Int -> CreateNotificationSubscription -> Int #

hash :: CreateNotificationSubscription -> Int #

type AWSResponse CreateNotificationSubscription Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

type AWSResponse CreateNotificationSubscription = CreateNotificationSubscriptionResponse
type Rep CreateNotificationSubscription Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

type Rep CreateNotificationSubscription = D1 ('MetaData "CreateNotificationSubscription" "Amazonka.WorkDocs.CreateNotificationSubscription" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "CreateNotificationSubscription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubscriptionProtocolType) :*: S1 ('MetaSel ('Just "subscriptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubscriptionType))))

newCreateNotificationSubscription Source #

Arguments

:: Text

CreateNotificationSubscription

-> Text

$sel:endpoint:CreateNotificationSubscription'

-> SubscriptionProtocolType

CreateNotificationSubscription

-> SubscriptionType

$sel:subscriptionType:CreateNotificationSubscription'

-> CreateNotificationSubscription 

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

CreateNotificationSubscription, createNotificationSubscription_organizationId - The ID of the organization.

$sel:endpoint:CreateNotificationSubscription', createNotificationSubscription_endpoint - The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with https.

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

$sel:subscriptionType:CreateNotificationSubscription', createNotificationSubscription_subscriptionType - The notification type.

Request Lenses

createNotificationSubscription_organizationId :: Lens' CreateNotificationSubscription Text Source #

The ID of the organization.

createNotificationSubscription_endpoint :: Lens' CreateNotificationSubscription Text Source #

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

createNotificationSubscription_protocol :: Lens' CreateNotificationSubscription SubscriptionProtocolType Source #

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

createNotificationSubscription_subscriptionType :: Lens' CreateNotificationSubscription SubscriptionType Source #

The notification type.

Destructuring the Response

data CreateNotificationSubscriptionResponse Source #

See: newCreateNotificationSubscriptionResponse smart constructor.

Constructors

CreateNotificationSubscriptionResponse' 

Fields

Instances

Instances details
Generic CreateNotificationSubscriptionResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Associated Types

type Rep CreateNotificationSubscriptionResponse :: Type -> Type #

Methods

from :: CreateNotificationSubscriptionResponse -> Rep CreateNotificationSubscriptionResponse x #

to :: Rep CreateNotificationSubscriptionResponse x -> CreateNotificationSubscriptionResponse #

Read CreateNotificationSubscriptionResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Methods

readsPrec :: Int -> ReadS CreateNotificationSubscriptionResponse #

readList :: ReadS [CreateNotificationSubscriptionResponse] #

readPrec :: ReadPrec CreateNotificationSubscriptionResponse #

readListPrec :: ReadPrec [CreateNotificationSubscriptionResponse] #

Show CreateNotificationSubscriptionResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Methods

showsPrec :: Int -> CreateNotificationSubscriptionResponse -> ShowS #

show :: CreateNotificationSubscriptionResponse -> String #

showList :: [CreateNotificationSubscriptionResponse] -> ShowS #

NFData CreateNotificationSubscriptionResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Methods

rnf :: CreateNotificationSubscriptionResponse -> () #

Eq CreateNotificationSubscriptionResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

Methods

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

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

type Rep CreateNotificationSubscriptionResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateNotificationSubscription

type Rep CreateNotificationSubscriptionResponse = D1 ('MetaData "CreateNotificationSubscriptionResponse" "Amazonka.WorkDocs.CreateNotificationSubscription" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "CreateNotificationSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Subscription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateNotificationSubscriptionResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateNotificationSubscriptionResponse'

-> CreateNotificationSubscriptionResponse 

Create a value of CreateNotificationSubscriptionResponse 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:subscription:CreateNotificationSubscriptionResponse', createNotificationSubscriptionResponse_subscription - The subscription.

$sel:httpStatus:CreateNotificationSubscriptionResponse', createNotificationSubscriptionResponse_httpStatus - The response's http status code.

Response Lenses

createNotificationSubscriptionResponse_subscription :: Lens' CreateNotificationSubscriptionResponse (Maybe Subscription) Source #

The subscription.

createNotificationSubscriptionResponse_httpStatus :: Lens' CreateNotificationSubscriptionResponse Int Source #

The response's http status code.