AWSCodeStarNotificationsAsync (AWS Java SDK for AWS CodeStar Notifications 1.11.795 API)

All Superinterfaces:

AWSCodeStarNotifications

All Known Implementing Classes:

AbstractAWSCodeStarNotificationsAsync, AWSCodeStarNotificationsAsyncClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCodeStarNotificationsAsync
extends AWSCodeStarNotifications
```
Interface for accessing AWS CodeStar Notifications asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCodeStarNotificationsAsync instead.

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 (SNS topic) 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 link in the CodeStarNotifications User Guide.

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Future<CreateNotificationRuleResult>`	`createNotificationRuleAsync(CreateNotificationRuleRequest createNotificationRuleRequest)` Creates a notification rule for a resource.
`Future<CreateNotificationRuleResult>`	`createNotificationRuleAsync(CreateNotificationRuleRequest createNotificationRuleRequest, AsyncHandler<CreateNotificationRuleRequest,CreateNotificationRuleResult> asyncHandler)` Creates a notification rule for a resource.
`Future<DeleteNotificationRuleResult>`	`deleteNotificationRuleAsync(DeleteNotificationRuleRequest deleteNotificationRuleRequest)` Deletes a notification rule for a resource.
`Future<DeleteNotificationRuleResult>`	`deleteNotificationRuleAsync(DeleteNotificationRuleRequest deleteNotificationRuleRequest, AsyncHandler<DeleteNotificationRuleRequest,DeleteNotificationRuleResult> asyncHandler)` Deletes a notification rule for a resource.
`Future<DeleteTargetResult>`	`deleteTargetAsync(DeleteTargetRequest deleteTargetRequest)` Deletes a specified target for notifications.
`Future<DeleteTargetResult>`	`deleteTargetAsync(DeleteTargetRequest deleteTargetRequest, AsyncHandler<DeleteTargetRequest,DeleteTargetResult> asyncHandler)` Deletes a specified target for notifications.
`Future<DescribeNotificationRuleResult>`	`describeNotificationRuleAsync(DescribeNotificationRuleRequest describeNotificationRuleRequest)` Returns information about a specified notification rule.
`Future<DescribeNotificationRuleResult>`	`describeNotificationRuleAsync(DescribeNotificationRuleRequest describeNotificationRuleRequest, AsyncHandler<DescribeNotificationRuleRequest,DescribeNotificationRuleResult> asyncHandler)` Returns information about a specified notification rule.
`Future<ListEventTypesResult>`	`listEventTypesAsync(ListEventTypesRequest listEventTypesRequest)` Returns information about the event types available for configuring notifications.
`Future<ListEventTypesResult>`	`listEventTypesAsync(ListEventTypesRequest listEventTypesRequest, AsyncHandler<ListEventTypesRequest,ListEventTypesResult> asyncHandler)` Returns information about the event types available for configuring notifications.
`Future<ListNotificationRulesResult>`	`listNotificationRulesAsync(ListNotificationRulesRequest listNotificationRulesRequest)` Returns a list of the notification rules for an AWS account.
`Future<ListNotificationRulesResult>`	`listNotificationRulesAsync(ListNotificationRulesRequest listNotificationRulesRequest, AsyncHandler<ListNotificationRulesRequest,ListNotificationRulesResult> asyncHandler)` Returns a list of the notification rules for an AWS account.
`Future<ListTagsForResourceResult>`	`listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)` Returns a list of the tags associated with a notification rule.
`Future<ListTagsForResourceResult>`	`listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)` Returns a list of the tags associated with a notification rule.
`Future<ListTargetsResult>`	`listTargetsAsync(ListTargetsRequest listTargetsRequest)` Returns a list of the notification rule targets for an AWS account.
`Future<ListTargetsResult>`	`listTargetsAsync(ListTargetsRequest listTargetsRequest, AsyncHandler<ListTargetsRequest,ListTargetsResult> asyncHandler)` Returns a list of the notification rule targets for an AWS account.
`Future<SubscribeResult>`	`subscribeAsync(SubscribeRequest subscribeRequest)` Creates an association between a notification rule and an SNS topic so that the associated target can receive notifications when the events described in the rule are triggered.
`Future<SubscribeResult>`	`subscribeAsync(SubscribeRequest subscribeRequest, AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)` Creates an association between a notification rule and an SNS topic so that the associated target can receive notifications when the events described in the rule are triggered.
`Future<TagResourceResult>`	`tagResourceAsync(TagResourceRequest tagResourceRequest)` Associates a set of provided tags with a notification rule.
`Future<TagResourceResult>`	`tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)` Associates a set of provided tags with a notification rule.
`Future<UnsubscribeResult>`	`unsubscribeAsync(UnsubscribeRequest unsubscribeRequest)` Removes an association between a notification rule and an Amazon SNS topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.
`Future<UnsubscribeResult>`	`unsubscribeAsync(UnsubscribeRequest unsubscribeRequest, AsyncHandler<UnsubscribeRequest,UnsubscribeResult> asyncHandler)` Removes an association between a notification rule and an Amazon SNS topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.
`Future<UntagResourceResult>`	`untagResourceAsync(UntagResourceRequest untagResourceRequest)` Removes the association between one or more provided tags and a notification rule.
`Future<UntagResourceResult>`	`untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)` Removes the association between one or more provided tags and a notification rule.
`Future<UpdateNotificationRuleResult>`	`updateNotificationRuleAsync(UpdateNotificationRuleRequest updateNotificationRuleRequest)` Updates a notification rule for a resource.
`Future<UpdateNotificationRuleResult>`	`updateNotificationRuleAsync(UpdateNotificationRuleRequest updateNotificationRuleRequest, AsyncHandler<UpdateNotificationRuleRequest,UpdateNotificationRuleResult> asyncHandler)` Updates a notification rule for a resource.

Methods inherited from interface com.amazonaws.services.codestarnotifications.AWSCodeStarNotifications
createNotificationRule, deleteNotificationRule, deleteTarget, describeNotificationRule, getCachedResponseMetadata, listEventTypes, listNotificationRules, listTagsForResource, listTargets, shutdown, subscribe, tagResource, unsubscribe, untagResource, updateNotificationRule

- Method Detail
  - createNotificationRuleAsync
```
Future<CreateNotificationRuleResult> createNotificationRuleAsync(CreateNotificationRuleRequest createNotificationRuleRequest)
```
    Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as SNS topics) where you want to receive them.
    
    Parameters:
    
    createNotificationRuleRequest -
    
    Returns:
    
    A Java Future containing the result of the CreateNotificationRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createNotificationRuleAsync
```
Future<CreateNotificationRuleResult> createNotificationRuleAsync(CreateNotificationRuleRequest createNotificationRuleRequest,
                                                                 AsyncHandler<CreateNotificationRuleRequest,CreateNotificationRuleResult> asyncHandler)
```
    Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as SNS topics) where you want to receive them.
    
    Parameters:
    
    createNotificationRuleRequest -
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the CreateNotificationRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteNotificationRuleAsync
```
Future<DeleteNotificationRuleResult> deleteNotificationRuleAsync(DeleteNotificationRuleRequest deleteNotificationRuleRequest)
```
    Deletes a notification rule for a resource.
    
    Parameters:
    
    deleteNotificationRuleRequest -
    
    Returns:
    
    A Java Future containing the result of the DeleteNotificationRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteNotificationRuleAsync
```
Future<DeleteNotificationRuleResult> deleteNotificationRuleAsync(DeleteNotificationRuleRequest deleteNotificationRuleRequest,
                                                                 AsyncHandler<DeleteNotificationRuleRequest,DeleteNotificationRuleResult> asyncHandler)
```
    Deletes a notification rule for a resource.
    
    Parameters:
    
    deleteNotificationRuleRequest -
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the DeleteNotificationRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTargetAsync
```
Future<DeleteTargetResult> deleteTargetAsync(DeleteTargetRequest deleteTargetRequest)
```
    Deletes a specified target for notifications.
    
    Parameters:
    
    deleteTargetRequest -
    
    Returns:
    
    A Java Future containing the result of the DeleteTarget operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTargetAsync
```
Future<DeleteTargetResult> deleteTargetAsync(DeleteTargetRequest deleteTargetRequest,
                                             AsyncHandler<DeleteTargetRequest,DeleteTargetResult> asyncHandler)
```
    Deletes a specified target for notifications.
    
    Parameters:
    
    deleteTargetRequest -
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the DeleteTarget operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeNotificationRuleAsync
```
Future<DescribeNotificationRuleResult> describeNotificationRuleAsync(DescribeNotificationRuleRequest describeNotificationRuleRequest)
```
    Returns information about a specified notification rule.
    
    Parameters:
    
    describeNotificationRuleRequest -
    
    Returns:
    
    A Java Future containing the result of the DescribeNotificationRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeNotificationRuleAsync
```
Future<DescribeNotificationRuleResult> describeNotificationRuleAsync(DescribeNotificationRuleRequest describeNotificationRuleRequest,
                                                                     AsyncHandler<DescribeNotificationRuleRequest,DescribeNotificationRuleResult> asyncHandler)
```
    Returns information about a specified notification rule.
    
    Parameters:
    
    describeNotificationRuleRequest -
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the DescribeNotificationRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEventTypesAsync
```
Future<ListEventTypesResult> listEventTypesAsync(ListEventTypesRequest listEventTypesRequest)
```
    Returns information about the event types available for configuring notifications.
    
    Parameters:
    
    listEventTypesRequest -
    
    Returns:
    
    A Java Future containing the result of the ListEventTypes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEventTypesAsync
```
Future<ListEventTypesResult> listEventTypesAsync(ListEventTypesRequest listEventTypesRequest,
                                                 AsyncHandler<ListEventTypesRequest,ListEventTypesResult> asyncHandler)
```
    Returns information about the event types available for configuring notifications.
    
    Parameters:
    
    listEventTypesRequest -
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ListEventTypes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listNotificationRulesAsync
```
Future<ListNotificationRulesResult> listNotificationRulesAsync(ListNotificationRulesRequest listNotificationRulesRequest)
```
    Returns a list of the notification rules for an AWS account.
    
    Parameters:
    
    listNotificationRulesRequest -
    
    Returns:
    
    A Java Future containing the result of the ListNotificationRules operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listNotificationRulesAsync
```
Future<ListNotificationRulesResult> listNotificationRulesAsync(ListNotificationRulesRequest listNotificationRulesRequest,
                                                               AsyncHandler<ListNotificationRulesRequest,ListNotificationRulesResult> asyncHandler)
```
    Returns a list of the notification rules for an AWS account.
    
    Parameters:
    
    listNotificationRulesRequest -
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ListNotificationRules operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResourceAsync
```
Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns a list of the tags associated with a notification rule.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    A Java Future containing the result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResourceAsync
```
Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
                                                           AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
```
    Returns a list of the tags associated with a notification rule.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTargetsAsync
```
Future<ListTargetsResult> listTargetsAsync(ListTargetsRequest listTargetsRequest)
```
    Returns a list of the notification rule targets for an AWS account.
    
    Parameters:
    
    listTargetsRequest -
    
    Returns:
    
    A Java Future containing the result of the ListTargets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTargetsAsync
```
Future<ListTargetsResult> listTargetsAsync(ListTargetsRequest listTargetsRequest,
                                           AsyncHandler<ListTargetsRequest,ListTargetsResult> asyncHandler)
```
    Returns a list of the notification rule targets for an AWS account.
    
    Parameters:
    
    listTargetsRequest -
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ListTargets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - subscribeAsync
```
Future<SubscribeResult> subscribeAsync(SubscribeRequest subscribeRequest)
```
    Creates an association between a notification rule and an SNS topic so that the associated target can receive notifications when the events described in the rule are triggered.
    
    Parameters:
    
    subscribeRequest -
    
    Returns:
    
    A Java Future containing the result of the Subscribe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - subscribeAsync
```
Future<SubscribeResult> subscribeAsync(SubscribeRequest subscribeRequest,
                                       AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
```
    Creates an association between a notification rule and an SNS topic so that the associated target can receive notifications when the events described in the rule are triggered.
    
    Parameters:
    
    subscribeRequest -
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the Subscribe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResourceAsync
```
Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
```
    Associates a set of provided tags with a notification rule.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    A Java Future containing the result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResourceAsync
```
Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest,
                                           AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
```
    Associates a set of provided tags with a notification rule.
    
    Parameters:
    
    tagResourceRequest -
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - unsubscribeAsync
```
Future<UnsubscribeResult> unsubscribeAsync(UnsubscribeRequest unsubscribeRequest)
```
    Removes an association between a notification rule and an Amazon SNS topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.
    
    Parameters:
    
    unsubscribeRequest -
    
    Returns:
    
    A Java Future containing the result of the Unsubscribe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - unsubscribeAsync
```
Future<UnsubscribeResult> unsubscribeAsync(UnsubscribeRequest unsubscribeRequest,
                                           AsyncHandler<UnsubscribeRequest,UnsubscribeResult> asyncHandler)
```
    Removes an association between a notification rule and an Amazon SNS topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.
    
    Parameters:
    
    unsubscribeRequest -
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the Unsubscribe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResourceAsync
```
Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
```
    Removes the association between one or more provided tags and a notification rule.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    A Java Future containing the result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResourceAsync
```
Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest,
                                               AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
```
    Removes the association between one or more provided tags and a notification rule.
    
    Parameters:
    
    untagResourceRequest -
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateNotificationRuleAsync
```
Future<UpdateNotificationRuleResult> updateNotificationRuleAsync(UpdateNotificationRuleRequest updateNotificationRuleRequest)
```
    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.
    
    Parameters:
    
    updateNotificationRuleRequest -
    
    Returns:
    
    A Java Future containing the result of the UpdateNotificationRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateNotificationRuleAsync
```
Future<UpdateNotificationRuleResult> updateNotificationRuleAsync(UpdateNotificationRuleRequest updateNotificationRuleRequest,
                                                                 AsyncHandler<UpdateNotificationRuleRequest,UpdateNotificationRuleResult> asyncHandler)
```
    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.
    
    Parameters:
    
    updateNotificationRuleRequest -
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the UpdateNotificationRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation

Interface AWSCodeStarNotificationsAsync

Field Summary

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

Method Summary

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

Method Detail

createNotificationRuleAsync

createNotificationRuleAsync

deleteNotificationRuleAsync

deleteNotificationRuleAsync

deleteTargetAsync

deleteTargetAsync

describeNotificationRuleAsync

describeNotificationRuleAsync

listEventTypesAsync

listEventTypesAsync

listNotificationRulesAsync

listNotificationRulesAsync

listTagsForResourceAsync

listTagsForResourceAsync

listTargetsAsync

listTargetsAsync

subscribeAsync

subscribeAsync

tagResourceAsync

tagResourceAsync

unsubscribeAsync

unsubscribeAsync

untagResourceAsync

untagResourceAsync

updateNotificationRuleAsync

updateNotificationRuleAsync