github.com/aavshr/aws-sdk-go@v1.41.3/service/codestarnotifications/doc.go (about)

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package codestarnotifications provides the client and types for making API
     4  // requests to AWS CodeStar Notifications.
     5  //
     6  // This AWS CodeStar Notifications API Reference provides descriptions and usage
     7  // examples of the operations and data types for the AWS CodeStar Notifications
     8  // API. You can use the AWS CodeStar Notifications API to work with the following
     9  // objects:
    10  //
    11  // Notification rules, by calling the following:
    12  //
    13  //    * CreateNotificationRule, which creates a notification rule for a resource
    14  //    in your account.
    15  //
    16  //    * DeleteNotificationRule, which deletes a notification rule.
    17  //
    18  //    * DescribeNotificationRule, which provides information about a notification
    19  //    rule.
    20  //
    21  //    * ListNotificationRules, which lists the notification rules associated
    22  //    with your account.
    23  //
    24  //    * UpdateNotificationRule, which changes the name, events, or targets associated
    25  //    with a notification rule.
    26  //
    27  //    * Subscribe, which subscribes a target to a notification rule.
    28  //
    29  //    * Unsubscribe, which removes a target from a notification rule.
    30  //
    31  // Targets, by calling the following:
    32  //
    33  //    * DeleteTarget, which removes a notification rule target (SNS topic) from
    34  //    a notification rule.
    35  //
    36  //    * ListTargets, which lists the targets associated with a notification
    37  //    rule.
    38  //
    39  // Events, by calling the following:
    40  //
    41  //    * ListEventTypes, which lists the event types you can include in a notification
    42  //    rule.
    43  //
    44  // Tags, by calling the following:
    45  //
    46  //    * ListTagsForResource, which lists the tags already associated with a
    47  //    notification rule in your account.
    48  //
    49  //    * TagResource, which associates a tag you provide with a notification
    50  //    rule in your account.
    51  //
    52  //    * UntagResource, which removes a tag from a notification rule in your
    53  //    account.
    54  //
    55  // For information about how to use AWS CodeStar Notifications, see link in
    56  // the CodeStarNotifications User Guide.
    57  //
    58  // See https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15 for more information on this service.
    59  //
    60  // See codestarnotifications package documentation for more information.
    61  // https://docs.aws.amazon.com/sdk-for-go/api/service/codestarnotifications/
    62  //
    63  // Using the Client
    64  //
    65  // To contact AWS CodeStar Notifications with the SDK use the New function to create
    66  // a new service client. With that client you can make API requests to the service.
    67  // These clients are safe to use concurrently.
    68  //
    69  // See the SDK's documentation for more information on how to use the SDK.
    70  // https://docs.aws.amazon.com/sdk-for-go/api/
    71  //
    72  // See aws.Config documentation for more information on configuring SDK clients.
    73  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    74  //
    75  // See the AWS CodeStar Notifications client CodeStarNotifications for more
    76  // information on creating client for this service.
    77  // https://docs.aws.amazon.com/sdk-for-go/api/service/codestarnotifications/#New
    78  package codestarnotifications