codestarnotifications/aws.sdk.kotlin.services.codestarnotifications

Package-level declarations

Types

interface CodestarNotificationsClient : SdkClient

This CodeStar Notifications API Reference provides descriptions and usage examples of the operations and data types for the CodeStar Notifications API. You can use the CodeStar Notifications API to work with the following objects:

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createNotificationRule

inline suspend fun CodestarNotificationsClient.createNotificationRule(crossinline block: CreateNotificationRuleRequest.Builder.() -> Unit): CreateNotificationRuleResponse

Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as Chatbot topics or Chatbot clients configured for Slack) where you want to receive them.

deleteNotificationRule

inline suspend fun CodestarNotificationsClient.deleteNotificationRule(crossinline block: DeleteNotificationRuleRequest.Builder.() -> Unit): DeleteNotificationRuleResponse

Deletes a notification rule for a resource.

deleteTarget

inline suspend fun CodestarNotificationsClient.deleteTarget(crossinline block: DeleteTargetRequest.Builder.() -> Unit): DeleteTargetResponse

Deletes a specified target for notifications.

describeNotificationRule

inline suspend fun CodestarNotificationsClient.describeNotificationRule(crossinline block: DescribeNotificationRuleRequest.Builder.() -> Unit): DescribeNotificationRuleResponse

Returns information about a specified notification rule.

listEventTypes

inline suspend fun CodestarNotificationsClient.listEventTypes(crossinline block: ListEventTypesRequest.Builder.() -> Unit): ListEventTypesResponse

Returns information about the event types available for configuring notifications.

listNotificationRules

inline suspend fun CodestarNotificationsClient.listNotificationRules(crossinline block: ListNotificationRulesRequest.Builder.() -> Unit): ListNotificationRulesResponse

Returns a list of the notification rules for an Amazon Web Services account.

listTagsForResource

inline suspend fun CodestarNotificationsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns a list of the tags associated with a notification rule.

listTargets

inline suspend fun CodestarNotificationsClient.listTargets(crossinline block: ListTargetsRequest.Builder.() -> Unit): ListTargetsResponse

Returns a list of the notification rule targets for an Amazon Web Services account.

inline suspend fun CodestarNotificationsClient.subscribe(crossinline block: SubscribeRequest.Builder.() -> Unit): SubscribeResponse

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.

tagResource

inline suspend fun CodestarNotificationsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Associates a set of provided tags with a notification rule.

unsubscribe

inline suspend fun CodestarNotificationsClient.unsubscribe(crossinline block: UnsubscribeRequest.Builder.() -> Unit): UnsubscribeResponse

Removes an association between a notification rule and an Chatbot topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.

untagResource

inline suspend fun CodestarNotificationsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the association between one or more provided tags and a notification rule.

updateNotificationRule

inline suspend fun CodestarNotificationsClient.updateNotificationRule(crossinline block: UpdateNotificationRuleRequest.Builder.() -> Unit): UpdateNotificationRuleResponse

Updates a notification rule for a resource. You can change the events that trigger the notification rule, the status of the rule, and the targets that receive the notifications.

withConfig

fun CodestarNotificationsClient.withConfig(block: CodestarNotificationsClient.Config.Builder.() -> Unit): CodestarNotificationsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.