Amazonka.CodeStarNotifications.DescribeNotificationRule

Returns information about a specified notification rule.

Creating a Request

data DescribeNotificationRule

See: newDescribeNotificationRule smart constructor.

Constructors

DescribeNotificationRule'

Fields

• arn :: Text

  The Amazon Resource Name (ARN) of the notification rule.

Instances

ToJSON DescribeNotificationRule

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

Methods

toJSON :: DescribeNotificationRule -> Value

toEncoding :: DescribeNotificationRule -> Encoding

toJSONList :: [DescribeNotificationRule] -> Value

toEncodingList :: [DescribeNotificationRule] -> Encoding

ToHeaders DescribeNotificationRule

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

Methods

toHeaders :: DescribeNotificationRule -> [Header]

ToPath DescribeNotificationRule

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

Methods

toPath :: DescribeNotificationRule -> ByteString

ToQuery DescribeNotificationRule

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

Methods

toQuery :: DescribeNotificationRule -> QueryString

AWSRequest DescribeNotificationRule

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

Associated Types

type AWSResponse DescribeNotificationRule

Methods

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

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

Generic DescribeNotificationRule

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

Associated Types

type Rep DescribeNotificationRule :: Type -> Type

Methods

from :: DescribeNotificationRule -> Rep DescribeNotificationRule x

to :: Rep DescribeNotificationRule x -> DescribeNotificationRule

Read DescribeNotificationRule

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

Methods

readsPrec :: Int -> ReadS DescribeNotificationRule

readList :: ReadS [DescribeNotificationRule]

readPrec :: ReadPrec DescribeNotificationRule

readListPrec :: ReadPrec [DescribeNotificationRule]

Show DescribeNotificationRule

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

Methods

showsPrec :: Int -> DescribeNotificationRule -> ShowS

show :: DescribeNotificationRule -> String

showList :: [DescribeNotificationRule] -> ShowS

NFData DescribeNotificationRule

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

Methods

rnf :: DescribeNotificationRule -> ()

Eq DescribeNotificationRule

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

Methods

(==) :: DescribeNotificationRule -> DescribeNotificationRule -> Bool

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

Hashable DescribeNotificationRule

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

Methods

hashWithSalt :: Int -> DescribeNotificationRule -> Int

hash :: DescribeNotificationRule -> Int

type AWSResponse DescribeNotificationRule

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

type AWSResponse DescribeNotificationRule = DescribeNotificationRuleResponse

type Rep DescribeNotificationRule

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

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

newDescribeNotificationRule

Arguments

:: Text

DescribeNotificationRule

-> DescribeNotificationRule

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

DescribeNotificationRule, describeNotificationRule_arn - The Amazon Resource Name (ARN) of the notification rule.

Request Lenses

describeNotificationRule_arn :: Lens' DescribeNotificationRule Text

The Amazon Resource Name (ARN) of the notification rule.

Destructuring the Response

data DescribeNotificationRuleResponse

See: newDescribeNotificationRuleResponse smart constructor.

Constructors

DescribeNotificationRuleResponse'

Fields

• createdBy :: Maybe Text

  The name or email alias of the person who created the notification rule.

• createdTimestamp :: Maybe POSIX

  The date and time the notification rule was created, in timestamp format.

• detailType :: Maybe DetailType

  The level of detail included in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

• eventTypes :: Maybe [EventTypeSummary]

  A list of the event types associated with the notification rule.

• lastModifiedTimestamp :: Maybe POSIX

  The date and time the notification rule was most recently updated, in timestamp format.

• name :: Maybe (Sensitive Text)

  The name of the notification rule.

• resource :: Maybe Text

  The Amazon Resource Name (ARN) of the resource associated with the notification rule.

• status :: Maybe NotificationRuleStatus

  The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).

• tags :: Maybe (HashMap Text Text)

  The tags associated with the notification rule.

• targets :: Maybe [TargetSummary]

  A list of the Chatbot topics and Chatbot clients associated with the notification rule.

• httpStatus :: Int

  The response's http status code.

• arn :: Text

  The Amazon Resource Name (ARN) of the notification rule.

Instances

Generic DescribeNotificationRuleResponse

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

Associated Types

type Rep DescribeNotificationRuleResponse :: Type -> Type

Methods

from :: DescribeNotificationRuleResponse -> Rep DescribeNotificationRuleResponse x

to :: Rep DescribeNotificationRuleResponse x -> DescribeNotificationRuleResponse

Show DescribeNotificationRuleResponse

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

Methods

showsPrec :: Int -> DescribeNotificationRuleResponse -> ShowS

show :: DescribeNotificationRuleResponse -> String

showList :: [DescribeNotificationRuleResponse] -> ShowS

NFData DescribeNotificationRuleResponse

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

Methods

rnf :: DescribeNotificationRuleResponse -> ()

Eq DescribeNotificationRuleResponse

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

Methods

(==) :: DescribeNotificationRuleResponse -> DescribeNotificationRuleResponse -> Bool

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

type Rep DescribeNotificationRuleResponse

Defined in Amazonka.CodeStarNotifications.DescribeNotificationRule

type Rep DescribeNotificationRuleResponse = D1 ('MetaData "DescribeNotificationRuleResponse" "Amazonka.CodeStarNotifications.DescribeNotificationRule" "amazonka-codestar-notifications-2.0-1YU4g2Ny2gz2roMHW6JQnw" 'False) (C1 ('MetaCons "DescribeNotificationRuleResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "createdTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "detailType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DetailType)))) :*: (S1 ('MetaSel ('Just "eventTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventTypeSummary])) :*: (S1 ('MetaSel ('Just "lastModifiedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))) :*: ((S1 ('MetaSel ('Just "resource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationRuleStatus)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: (S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TargetSummary])) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newDescribeNotificationRuleResponse

Arguments

:: Int

$sel:httpStatus:DescribeNotificationRuleResponse'

-> Text

DescribeNotificationRule

-> DescribeNotificationRuleResponse

Create a value of DescribeNotificationRuleResponse 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:createdBy:DescribeNotificationRuleResponse', describeNotificationRuleResponse_createdBy - The name or email alias of the person who created the notification rule.

$sel:createdTimestamp:DescribeNotificationRuleResponse', describeNotificationRuleResponse_createdTimestamp - The date and time the notification rule was created, in timestamp format.

$sel:detailType:DescribeNotificationRuleResponse', describeNotificationRuleResponse_detailType - The level of detail included in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

$sel:eventTypes:DescribeNotificationRuleResponse', describeNotificationRuleResponse_eventTypes - A list of the event types associated with the notification rule.

$sel:lastModifiedTimestamp:DescribeNotificationRuleResponse', describeNotificationRuleResponse_lastModifiedTimestamp - The date and time the notification rule was most recently updated, in timestamp format.

DescribeNotificationRuleResponse, describeNotificationRuleResponse_name - The name of the notification rule.

$sel:resource:DescribeNotificationRuleResponse', describeNotificationRuleResponse_resource - The Amazon Resource Name (ARN) of the resource associated with the notification rule.

$sel:status:DescribeNotificationRuleResponse', describeNotificationRuleResponse_status - The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).

$sel:tags:DescribeNotificationRuleResponse', describeNotificationRuleResponse_tags - The tags associated with the notification rule.

$sel:targets:DescribeNotificationRuleResponse', describeNotificationRuleResponse_targets - A list of the Chatbot topics and Chatbot clients associated with the notification rule.

$sel:httpStatus:DescribeNotificationRuleResponse', describeNotificationRuleResponse_httpStatus - The response's http status code.

DescribeNotificationRule, describeNotificationRuleResponse_arn - The Amazon Resource Name (ARN) of the notification rule.

Response Lenses

describeNotificationRuleResponse_createdBy :: Lens' DescribeNotificationRuleResponse (Maybe Text)

The name or email alias of the person who created the notification rule.

describeNotificationRuleResponse_createdTimestamp :: Lens' DescribeNotificationRuleResponse (Maybe UTCTime)

The date and time the notification rule was created, in timestamp format.

describeNotificationRuleResponse_detailType :: Lens' DescribeNotificationRuleResponse (Maybe DetailType)

The level of detail included in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

describeNotificationRuleResponse_eventTypes :: Lens' DescribeNotificationRuleResponse (Maybe [EventTypeSummary])

A list of the event types associated with the notification rule.

describeNotificationRuleResponse_lastModifiedTimestamp :: Lens' DescribeNotificationRuleResponse (Maybe UTCTime)

The date and time the notification rule was most recently updated, in timestamp format.

describeNotificationRuleResponse_name :: Lens' DescribeNotificationRuleResponse (Maybe Text)

The name of the notification rule.

describeNotificationRuleResponse_resource :: Lens' DescribeNotificationRuleResponse (Maybe Text)

The Amazon Resource Name (ARN) of the resource associated with the notification rule.

describeNotificationRuleResponse_status :: Lens' DescribeNotificationRuleResponse (Maybe NotificationRuleStatus)

The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).

describeNotificationRuleResponse_tags :: Lens' DescribeNotificationRuleResponse (Maybe (HashMap Text Text))

The tags associated with the notification rule.

describeNotificationRuleResponse_targets :: Lens' DescribeNotificationRuleResponse (Maybe [TargetSummary])

A list of the Chatbot topics and Chatbot clients associated with the notification rule.

describeNotificationRuleResponse_httpStatus :: Lens' DescribeNotificationRuleResponse Int

The response's http status code.

describeNotificationRuleResponse_arn :: Lens' DescribeNotificationRuleResponse Text

The Amazon Resource Name (ARN) of the notification rule.