

*********************
CodeStarNotifications
*********************



======
Client
======



.. py:class:: CodeStarNotifications.Client

  A low-level client representing AWS CodeStar Notifications
  

  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:

   

  Notification rules, by calling the following:

   

  
  *  CreateNotificationRule, which creates a notification rule for a resource in your account.
   
  *  DeleteNotificationRule, which deletes a notification rule.
   
  *  DescribeNotificationRule, which provides information about a notification rule.
   
  *  ListNotificationRules, which lists the notification rules associated with your account.
   
  *  UpdateNotificationRule, which changes the name, events, or targets associated with a notification rule.
   
  *  Subscribe, which subscribes a target to a notification rule.
   
  *  Unsubscribe, which removes a target from a notification rule.
  

   

  Targets, by calling the following:

   

  
  *  DeleteTarget, which removes a notification rule target from a notification rule.
   
  *  ListTargets, which lists the targets associated with a notification rule.
  

   

  Events, by calling the following:

   

  
  *  ListEventTypes, which lists the event types you can include in a notification rule.
  

   

  Tags, by calling the following:

   

  
  *  ListTagsForResource, which lists the tags already associated with a notification rule in your account.
   
  *  TagResource, which associates a tag you provide with a notification rule in your account.
   
  *  UntagResource, which removes a tag from a notification rule in your account.
  

   

  For information about how to use CodeStar Notifications, see the `Amazon Web Services Developer Tools Console User Guide <https://docs.aws.amazon.com/dtconsole/latest/userguide/what-is-dtconsole.html>`__.

  ::

    
    import boto3
    
    client = boto3.client('codestar-notifications')

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  codestar-notifications/client/can_paginate
  codestar-notifications/client/close
  codestar-notifications/client/create_notification_rule
  codestar-notifications/client/delete_notification_rule
  codestar-notifications/client/delete_target
  codestar-notifications/client/describe_notification_rule
  codestar-notifications/client/get_paginator
  codestar-notifications/client/get_waiter
  codestar-notifications/client/list_event_types
  codestar-notifications/client/list_notification_rules
  codestar-notifications/client/list_tags_for_resource
  codestar-notifications/client/list_targets
  codestar-notifications/client/subscribe
  codestar-notifications/client/tag_resource
  codestar-notifications/client/unsubscribe
  codestar-notifications/client/untag_resource
  codestar-notifications/client/update_notification_rule


==========
Paginators
==========


Paginators are available on a client instance via the ``get_paginator`` method. For more detailed instructions and examples on the usage of paginators, see the paginators `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  codestar-notifications/paginator/ListEventTypes
  codestar-notifications/paginator/ListNotificationRules
  codestar-notifications/paginator/ListTargets
