amazonka-codestar-notifications-2.0: Amazon CodeStar Notifications 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.CodeStarNotifications.Subscribe

Description

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.

Synopsis

Creating a Request

data Subscribe Source #

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

Instances details
ToJSON Subscribe Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

ToHeaders Subscribe Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

Methods

toHeaders :: Subscribe -> [Header] #

ToPath Subscribe Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

ToQuery Subscribe Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

AWSRequest Subscribe Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

Associated Types

type AWSResponse Subscribe #

Generic Subscribe Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

Associated Types

type Rep Subscribe :: Type -> Type #

Show Subscribe Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

NFData Subscribe Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

Methods

rnf :: Subscribe -> () #

Eq Subscribe Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

Hashable Subscribe Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

type AWSResponse Subscribe Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

type Rep Subscribe Source # 
Instance details

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 Source #

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) Source #

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

subscribe_arn :: Lens' Subscribe Text Source #

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

Destructuring the Response

data SubscribeResponse Source #

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

Instances details
Generic SubscribeResponse Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

Associated Types

type Rep SubscribeResponse :: Type -> Type #

Read SubscribeResponse Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

Show SubscribeResponse Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

NFData SubscribeResponse Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

Methods

rnf :: SubscribeResponse -> () #

Eq SubscribeResponse Source # 
Instance details

Defined in Amazonka.CodeStarNotifications.Subscribe

type Rep SubscribeResponse Source # 
Instance details

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 Source #

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) Source #

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

subscribeResponse_httpStatus :: Lens' SubscribeResponse Int Source #

The response's http status code.