Skip to content

aws.codestar_notifications.describe_notification_rule

Example SQL Queries

SELECT * FROM
aws.codestar_notifications.describe_notification_rule
WHERE
"arn" = 'VALUE';

Description

Returns information about a specified notification rule.

Table Definition

Column NameColumn Data Type
arn Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
created_by

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

VARCHAR
created_timestamp

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

TIMESTAMP_S
detail_type

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.

VARCHAR
event_types

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

STRUCT(
"event_type_id" VARCHAR,
"service_name" VARCHAR,
"event_type_name" VARCHAR,
"resource_type" VARCHAR
)[]
Show child fields
event_types[]
Show child fields
event_types[].event_type_id

The system-generated ID of the event. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.

event_types[].event_type_name

The name of the event.

event_types[].resource_type

The resource type of the event.

event_types[].service_name

The name of the service for which the event applies.

last_modified_timestamp

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

TIMESTAMP_S
name

The name of the notification rule.

VARCHAR
resource

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

VARCHAR
status

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

VARCHAR
tags

The tags associated with the notification rule.

MAP(VARCHAR, VARCHAR)
targets

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

STRUCT(
"target_address" VARCHAR,
"target_type" VARCHAR,
"target_status" VARCHAR
)[]
Show child fields
targets[]
Show child fields
targets[].target_address

The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.

targets[].target_status

The status of the target.

targets[].target_type

The type of the target (for example, SNS).

  • Chatbot topics are specified as SNS.

  • Chatbot clients are specified as AWSChatbotSlack.