AWSCodeStarNotificationsClient (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.codestarnotifications

Class AWSCodeStarNotificationsClient

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.codestarnotifications.AWSCodeStarNotificationsClient

All Implemented Interfaces:

AWSCodeStarNotifications

Direct Known Subclasses:

AWSCodeStarNotificationsAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSCodeStarNotificationsClient
extends AmazonWebServiceClient
implements AWSCodeStarNotifications 
```
Client for accessing AWS CodeStar Notifications. All service calls made using this client are blocking, and will not return until the service call completes.

This AWS CodeStar Notifications API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Notifications API. You can use the AWS 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 AWS CodeStar Notifications, see the Amazon Web Services Developer Tools Console User Guide.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.codestarnotifications.AWSCodeStarNotifications
  ENDPOINT_PREFIX

Method Summary

All Methods
Modifier and Type	Method and Description
`static AWSCodeStarNotificationsClientBuilder`	`builder ()`
`CreateNotificationRuleResult`	`createNotificationRule (CreateNotificationRuleRequest request)` Creates a notification rule for a resource.
`DeleteNotificationRuleResult`	`deleteNotificationRule (DeleteNotificationRuleRequest request)` Deletes a notification rule for a resource.
`DeleteTargetResult`	`deleteTarget (DeleteTargetRequest request)` Deletes a specified target for notifications.
`DescribeNotificationRuleResult`	`describeNotificationRule (DescribeNotificationRuleRequest request)` Returns information about a specified notification rule.
`ResponseMetadata`	`getCachedResponseMetadata (AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`ListEventTypesResult`	`listEventTypes (ListEventTypesRequest request)` Returns information about the event types available for configuring notifications.
`ListNotificationRulesResult`	`listNotificationRules (ListNotificationRulesRequest request)` Returns a list of the notification rules for an Amazon Web Services account.
`ListTagsForResourceResult`	`listTagsForResource (ListTagsForResourceRequest request)` Returns a list of the tags associated with a notification rule.
`ListTargetsResult`	`listTargets (ListTargetsRequest request)` Returns a list of the notification rule targets for an Amazon Web Services account.
`void`	`shutdown ()` Shuts down this client object, releasing any resources that might be held open.
`SubscribeResult`	`subscribe (SubscribeRequest request)` 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.
`TagResourceResult`	`tagResource (TagResourceRequest request)` Associates a set of provided tags with a notification rule.
`UnsubscribeResult`	`unsubscribe (UnsubscribeRequest request)` 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.
`UntagResourceResult`	`untagResource (UntagResourceRequest request)` Removes the association between one or more provided tags and a notification rule.
`UpdateNotificationRuleResult`	`updateNotificationRule (UpdateNotificationRuleRequest request)` Updates a notification rule for a resource.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AWSCodeStarNotificationsClientBuilder builder()
```
  - createNotificationRule
```
public CreateNotificationRuleResult createNotificationRule(CreateNotificationRuleRequest request)
```
    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.
    
    Specified by:
    
    createNotificationRule in interface AWSCodeStarNotifications
    
    Parameters:
    
    createNotificationRuleRequest -
    
    Returns:
    
    Result of the CreateNotificationRule operation returned by the service.
    
    Throws:
    
    ResourceAlreadyExistsException - A resource with the same name or ID already exists. Notification rule names must be unique in your Amazon Web Services account.
    
    ValidationException - One or more parameter values are not valid.
    
    LimitExceededException - One of the AWS CodeStar Notifications limits has been exceeded. Limits apply to accounts, notification rules, notifications, resources, and targets. For more information, see Limits.
    
    ConfigurationException - Some or all of the configuration is incomplete, missing, or not valid.
    
    ConcurrentModificationException - AWS CodeStar Notifications can't complete the request because the resource is being modified by another process. Wait a few minutes and try again.
    
    AccessDeniedException - AWS CodeStar Notifications can't create the notification rule because you do not have sufficient permissions.
    
    See Also:
    
    AWS API Documentation
  - deleteNotificationRule
```
public DeleteNotificationRuleResult deleteNotificationRule(DeleteNotificationRuleRequest request)
```
    Deletes a notification rule for a resource.
    
    Specified by:
    
    deleteNotificationRule in interface AWSCodeStarNotifications
    
    Parameters:
    
    deleteNotificationRuleRequest -
    
    Returns:
    
    Result of the DeleteNotificationRule operation returned by the service.
    
    Throws:
    
    ValidationException - One or more parameter values are not valid.
    
    LimitExceededException - One of the AWS CodeStar Notifications limits has been exceeded. Limits apply to accounts, notification rules, notifications, resources, and targets. For more information, see Limits.
    
    ConcurrentModificationException - AWS CodeStar Notifications can't complete the request because the resource is being modified by another process. Wait a few minutes and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteTarget
```
public DeleteTargetResult deleteTarget(DeleteTargetRequest request)
```
    Deletes a specified target for notifications.
    
    Specified by:
    
    deleteTarget in interface AWSCodeStarNotifications
    
    Parameters:
    
    deleteTargetRequest -
    
    Returns:
    
    Result of the DeleteTarget operation returned by the service.
    
    Throws:
    
    ValidationException - One or more parameter values are not valid.
    
    See Also:
    
    AWS API Documentation
  - describeNotificationRule
```
public DescribeNotificationRuleResult describeNotificationRule(DescribeNotificationRuleRequest request)
```
    Returns information about a specified notification rule.
    
    Specified by:
    
    describeNotificationRule in interface AWSCodeStarNotifications
    
    Parameters:
    
    describeNotificationRuleRequest -
    
    Returns:
    
    Result of the DescribeNotificationRule operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - AWS CodeStar Notifications can't find a resource that matches the provided ARN.
    
    ValidationException - One or more parameter values are not valid.
    
    See Also:
    
    AWS API Documentation
  - listEventTypes
```
public ListEventTypesResult listEventTypes(ListEventTypesRequest request)
```
    Returns information about the event types available for configuring notifications.
    
    Specified by:
    
    listEventTypes in interface AWSCodeStarNotifications
    
    Parameters:
    
    listEventTypesRequest -
    
    Returns:
    
    Result of the ListEventTypes operation returned by the service.
    
    Throws:
    
    InvalidNextTokenException - The value for the enumeration token used in the request to return the next batch of the results is not valid.
    
    ValidationException - One or more parameter values are not valid.
    
    See Also:
    
    AWS API Documentation
  - listNotificationRules
```
public ListNotificationRulesResult listNotificationRules(ListNotificationRulesRequest request)
```
    Returns a list of the notification rules for an Amazon Web Services account.
    
    Specified by:
    
    listNotificationRules in interface AWSCodeStarNotifications
    
    Parameters:
    
    listNotificationRulesRequest -
    
    Returns:
    
    Result of the ListNotificationRules operation returned by the service.
    
    Throws:
    
    InvalidNextTokenException - The value for the enumeration token used in the request to return the next batch of the results is not valid.
    
    ValidationException - One or more parameter values are not valid.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Returns a list of the tags associated with a notification rule.
    
    Specified by:
    
    listTagsForResource in interface AWSCodeStarNotifications
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - AWS CodeStar Notifications can't find a resource that matches the provided ARN.
    
    ValidationException - One or more parameter values are not valid.
    
    See Also:
    
    AWS API Documentation
  - listTargets
```
public ListTargetsResult listTargets(ListTargetsRequest request)
```
    Returns a list of the notification rule targets for an Amazon Web Services account.
    
    Specified by:
    
    listTargets in interface AWSCodeStarNotifications
    
    Parameters:
    
    listTargetsRequest -
    
    Returns:
    
    Result of the ListTargets operation returned by the service.
    
    Throws:
    
    InvalidNextTokenException - The value for the enumeration token used in the request to return the next batch of the results is not valid.
    
    ValidationException - One or more parameter values are not valid.
    
    See Also:
    
    AWS API Documentation
  - subscribe
```
public SubscribeResult subscribe(SubscribeRequest request)
```
    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.
    
    Specified by:
    
    subscribe in interface AWSCodeStarNotifications
    
    Parameters:
    
    subscribeRequest -
    
    Returns:
    
    Result of the Subscribe operation returned by the service.
    
    Throws:
    
    ValidationException - One or more parameter values are not valid.
    
    ResourceNotFoundException - AWS CodeStar Notifications can't find a resource that matches the provided ARN.
    
    ConfigurationException - Some or all of the configuration is incomplete, missing, or not valid.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Associates a set of provided tags with a notification rule.
    
    Specified by:
    
    tagResource in interface AWSCodeStarNotifications
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - AWS CodeStar Notifications can't find a resource that matches the provided ARN.
    
    LimitExceededException - One of the AWS CodeStar Notifications limits has been exceeded. Limits apply to accounts, notification rules, notifications, resources, and targets. For more information, see Limits.
    
    ValidationException - One or more parameter values are not valid.
    
    ConcurrentModificationException - AWS CodeStar Notifications can't complete the request because the resource is being modified by another process. Wait a few minutes and try again.
    
    See Also:
    
    AWS API Documentation
  - unsubscribe
```
public UnsubscribeResult unsubscribe(UnsubscribeRequest request)
```
    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.
    
    Specified by:
    
    unsubscribe in interface AWSCodeStarNotifications
    
    Parameters:
    
    unsubscribeRequest -
    
    Returns:
    
    Result of the Unsubscribe operation returned by the service.
    
    Throws:
    
    ValidationException - One or more parameter values are not valid.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes the association between one or more provided tags and a notification rule.
    
    Specified by:
    
    untagResource in interface AWSCodeStarNotifications
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - AWS CodeStar Notifications can't find a resource that matches the provided ARN.
    
    LimitExceededException - One of the AWS CodeStar Notifications limits has been exceeded. Limits apply to accounts, notification rules, notifications, resources, and targets. For more information, see Limits.
    
    ValidationException - One or more parameter values are not valid.
    
    ConcurrentModificationException - AWS CodeStar Notifications can't complete the request because the resource is being modified by another process. Wait a few minutes and try again.
    
    See Also:
    
    AWS API Documentation
  - updateNotificationRule
```
public UpdateNotificationRuleResult updateNotificationRule(UpdateNotificationRuleRequest request)
```
    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.
    
    To add or remove tags for a notification rule, you must use TagResource and UntagResource.
    
    Specified by:
    
    updateNotificationRule in interface AWSCodeStarNotifications
    
    Parameters:
    
    updateNotificationRuleRequest -
    
    Returns:
    
    Result of the UpdateNotificationRule operation returned by the service.
    
    Throws:
    
    ValidationException - One or more parameter values are not valid.
    
    ResourceNotFoundException - AWS CodeStar Notifications can't find a resource that matches the provided ARN.
    
    ConfigurationException - Some or all of the configuration is incomplete, missing, or not valid.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSCodeStarNotifications
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSCodeStarNotifications
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class AWSCodeStarNotificationsClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.codestarnotifications.AWSCodeStarNotifications

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

createNotificationRule

deleteNotificationRule

deleteTarget

describeNotificationRule

listEventTypes

listNotificationRules

listTagsForResource

listTargets

subscribe

tagResource

unsubscribe

untagResource

updateNotificationRule

getCachedResponseMetadata

shutdown