Amazonka.CodeStarNotifications.Subscribe

Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the associated target can receive notifications when the events described in the rule are triggered.

Creating a Request

data Subscribe

See: newSubscribe smart constructor.

Constructors

Subscribe'

Fields

• clientRequestToken :: Maybe Text

  An enumeration token that, when provided in a request, returns the next batch of the results.

• arn :: Text

  The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.

• target :: Target

Instances

ToJSON Subscribe

Defined in Amazonka.CodeStarNotifications.Subscribe

Methods

toJSON :: Subscribe -> Value

toEncoding :: Subscribe -> Encoding

toJSONList :: [Subscribe] -> Value

toEncodingList :: [Subscribe] -> Encoding

ToHeaders Subscribe

Defined in Amazonka.CodeStarNotifications.Subscribe

Methods

toHeaders :: Subscribe -> [Header]

ToPath Subscribe

Defined in Amazonka.CodeStarNotifications.Subscribe

Methods

toPath :: Subscribe -> ByteString

ToQuery Subscribe

Defined in Amazonka.CodeStarNotifications.Subscribe

Methods

toQuery :: Subscribe -> QueryString

AWSRequest Subscribe

Defined in Amazonka.CodeStarNotifications.Subscribe

Associated Types

type AWSResponse Subscribe

Methods

request :: (Service -> Service) -> Subscribe -> Request Subscribe

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

Generic Subscribe

Defined in Amazonka.CodeStarNotifications.Subscribe

Associated Types

type Rep Subscribe :: Type -> Type

Methods

from :: Subscribe -> Rep Subscribe x

to :: Rep Subscribe x -> Subscribe

Show Subscribe

Defined in Amazonka.CodeStarNotifications.Subscribe

Methods

showsPrec :: Int -> Subscribe -> ShowS

show :: Subscribe -> String

showList :: [Subscribe] -> ShowS

NFData Subscribe

Defined in Amazonka.CodeStarNotifications.Subscribe

Methods

rnf :: Subscribe -> ()

Eq Subscribe

Defined in Amazonka.CodeStarNotifications.Subscribe

Methods

(==) :: Subscribe -> Subscribe -> Bool

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

Hashable Subscribe

Defined in Amazonka.CodeStarNotifications.Subscribe

Methods

hashWithSalt :: Int -> Subscribe -> Int

hash :: Subscribe -> Int

type AWSResponse Subscribe

Defined in Amazonka.CodeStarNotifications.Subscribe

type AWSResponse Subscribe = SubscribeResponse

type Rep Subscribe

Defined in Amazonka.CodeStarNotifications.Subscribe

type Rep Subscribe = D1 ('MetaData "Subscribe" "Amazonka.CodeStarNotifications.Subscribe" "amazonka-codestar-notifications-2.0-1YU4g2Ny2gz2roMHW6JQnw" 'False) (C1 ('MetaCons "Subscribe'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Target))))

newSubscribe

Arguments

:: Text

Subscribe

-> Target

$sel:target:Subscribe'

-> Subscribe

Create a value of Subscribe 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:clientRequestToken:Subscribe', subscribe_clientRequestToken - An enumeration token that, when provided in a request, returns the next batch of the results.

Subscribe, subscribe_arn - The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.

$sel:target:Subscribe', subscribe_target - Undocumented member.

Request Lenses

subscribe_clientRequestToken :: Lens' Subscribe (Maybe Text)

An enumeration token that, when provided in a request, returns the next batch of the results.

subscribe_arn :: Lens' Subscribe Text

The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.

subscribe_target :: Lens' Subscribe Target

Undocumented member.

Destructuring the Response

data SubscribeResponse

See: newSubscribeResponse smart constructor.

Constructors

SubscribeResponse'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of the notification rule for which you have created assocations.

• httpStatus :: Int

  The response's http status code.

Instances

Generic SubscribeResponse

Defined in Amazonka.CodeStarNotifications.Subscribe

Associated Types

type Rep SubscribeResponse :: Type -> Type

Methods

from :: SubscribeResponse -> Rep SubscribeResponse x

to :: Rep SubscribeResponse x -> SubscribeResponse

Read SubscribeResponse

Defined in Amazonka.CodeStarNotifications.Subscribe

Methods

readsPrec :: Int -> ReadS SubscribeResponse

readList :: ReadS [SubscribeResponse]

readPrec :: ReadPrec SubscribeResponse

readListPrec :: ReadPrec [SubscribeResponse]

Show SubscribeResponse

Defined in Amazonka.CodeStarNotifications.Subscribe

Methods

showsPrec :: Int -> SubscribeResponse -> ShowS

show :: SubscribeResponse -> String

showList :: [SubscribeResponse] -> ShowS

NFData SubscribeResponse

Defined in Amazonka.CodeStarNotifications.Subscribe

Methods

rnf :: SubscribeResponse -> ()

Eq SubscribeResponse

Defined in Amazonka.CodeStarNotifications.Subscribe

Methods

(==) :: SubscribeResponse -> SubscribeResponse -> Bool

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

type Rep SubscribeResponse

Defined in Amazonka.CodeStarNotifications.Subscribe

type Rep SubscribeResponse = D1 ('MetaData "SubscribeResponse" "Amazonka.CodeStarNotifications.Subscribe" "amazonka-codestar-notifications-2.0-1YU4g2Ny2gz2roMHW6JQnw" 'False) (C1 ('MetaCons "SubscribeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSubscribeResponse

Arguments

:: Int

$sel:httpStatus:SubscribeResponse'

-> SubscribeResponse

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

Subscribe, subscribeResponse_arn - The Amazon Resource Name (ARN) of the notification rule for which you have created assocations.

$sel:httpStatus:SubscribeResponse', subscribeResponse_httpStatus - The response's http status code.

Response Lenses

subscribeResponse_arn :: Lens' SubscribeResponse (Maybe Text)

The Amazon Resource Name (ARN) of the notification rule for which you have created assocations.

subscribeResponse_httpStatus :: Lens' SubscribeResponse Int

The response's http status code.