@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCodeStarNotificationsAsyncClient extends AWSCodeStarNotificationsClient implements AWSCodeStarNotificationsAsync
AsyncHandler can be used to receive
notification when an asynchronous operation 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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AWSCodeStarNotificationsAsyncClientBuilder |
asyncBuilder() |
Future<CreateNotificationRuleResult> |
createNotificationRuleAsync(CreateNotificationRuleRequest request)
Creates a notification rule for a resource.
|
Future<CreateNotificationRuleResult> |
createNotificationRuleAsync(CreateNotificationRuleRequest request,
AsyncHandler<CreateNotificationRuleRequest,CreateNotificationRuleResult> asyncHandler)
Creates a notification rule for a resource.
|
Future<DeleteNotificationRuleResult> |
deleteNotificationRuleAsync(DeleteNotificationRuleRequest request)
Deletes a notification rule for a resource.
|
Future<DeleteNotificationRuleResult> |
deleteNotificationRuleAsync(DeleteNotificationRuleRequest request,
AsyncHandler<DeleteNotificationRuleRequest,DeleteNotificationRuleResult> asyncHandler)
Deletes a notification rule for a resource.
|
Future<DeleteTargetResult> |
deleteTargetAsync(DeleteTargetRequest request)
Deletes a specified target for notifications.
|
Future<DeleteTargetResult> |
deleteTargetAsync(DeleteTargetRequest request,
AsyncHandler<DeleteTargetRequest,DeleteTargetResult> asyncHandler)
Deletes a specified target for notifications.
|
Future<DescribeNotificationRuleResult> |
describeNotificationRuleAsync(DescribeNotificationRuleRequest request)
Returns information about a specified notification rule.
|
Future<DescribeNotificationRuleResult> |
describeNotificationRuleAsync(DescribeNotificationRuleRequest request,
AsyncHandler<DescribeNotificationRuleRequest,DescribeNotificationRuleResult> asyncHandler)
Returns information about a specified notification rule.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<ListEventTypesResult> |
listEventTypesAsync(ListEventTypesRequest request)
Returns information about the event types available for configuring notifications.
|
Future<ListEventTypesResult> |
listEventTypesAsync(ListEventTypesRequest request,
AsyncHandler<ListEventTypesRequest,ListEventTypesResult> asyncHandler)
Returns information about the event types available for configuring notifications.
|
Future<ListNotificationRulesResult> |
listNotificationRulesAsync(ListNotificationRulesRequest request)
Returns a list of the notification rules for an Amazon Web Services account.
|
Future<ListNotificationRulesResult> |
listNotificationRulesAsync(ListNotificationRulesRequest request,
AsyncHandler<ListNotificationRulesRequest,ListNotificationRulesResult> asyncHandler)
Returns a list of the notification rules for an Amazon Web Services account.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest request)
Returns a list of the tags associated with a notification rule.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest request,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Returns a list of the tags associated with a notification rule.
|
Future<ListTargetsResult> |
listTargetsAsync(ListTargetsRequest request)
Returns a list of the notification rule targets for an Amazon Web Services account.
|
Future<ListTargetsResult> |
listTargetsAsync(ListTargetsRequest request,
AsyncHandler<ListTargetsRequest,ListTargetsResult> asyncHandler)
Returns a list of the notification rule targets for an Amazon Web Services account.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<SubscribeResult> |
subscribeAsync(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.
|
Future<SubscribeResult> |
subscribeAsync(SubscribeRequest request,
AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
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.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest request)
Associates a set of provided tags with a notification rule.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest request,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Associates a set of provided tags with a notification rule.
|
Future<UnsubscribeResult> |
unsubscribeAsync(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.
|
Future<UnsubscribeResult> |
unsubscribeAsync(UnsubscribeRequest request,
AsyncHandler<UnsubscribeRequest,UnsubscribeResult> asyncHandler)
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.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request)
Removes the association between one or more provided tags and a notification rule.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes the association between one or more provided tags and a notification rule.
|
Future<UpdateNotificationRuleResult> |
updateNotificationRuleAsync(UpdateNotificationRuleRequest request)
Updates a notification rule for a resource.
|
Future<UpdateNotificationRuleResult> |
updateNotificationRuleAsync(UpdateNotificationRuleRequest request,
AsyncHandler<UpdateNotificationRuleRequest,UpdateNotificationRuleResult> asyncHandler)
Updates a notification rule for a resource.
|
builder, createNotificationRule, deleteNotificationRule, deleteTarget, describeNotificationRule, getCachedResponseMetadata, listEventTypes, listNotificationRules, listTagsForResource, listTargets, subscribe, tagResource, unsubscribe, untagResource, updateNotificationRuleaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateNotificationRule, deleteNotificationRule, deleteTarget, describeNotificationRule, getCachedResponseMetadata, listEventTypes, listNotificationRules, listTagsForResource, listTargets, subscribe, tagResource, unsubscribe, untagResource, updateNotificationRulepublic static AWSCodeStarNotificationsAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateNotificationRuleResult> createNotificationRuleAsync(CreateNotificationRuleRequest request)
AWSCodeStarNotificationsAsyncCreates 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.
createNotificationRuleAsync in interface AWSCodeStarNotificationsAsyncpublic Future<CreateNotificationRuleResult> createNotificationRuleAsync(CreateNotificationRuleRequest request, AsyncHandler<CreateNotificationRuleRequest,CreateNotificationRuleResult> asyncHandler)
AWSCodeStarNotificationsAsyncCreates 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.
createNotificationRuleAsync in interface AWSCodeStarNotificationsAsyncasyncHandler - 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.public Future<DeleteNotificationRuleResult> deleteNotificationRuleAsync(DeleteNotificationRuleRequest request)
AWSCodeStarNotificationsAsyncDeletes a notification rule for a resource.
deleteNotificationRuleAsync in interface AWSCodeStarNotificationsAsyncpublic Future<DeleteNotificationRuleResult> deleteNotificationRuleAsync(DeleteNotificationRuleRequest request, AsyncHandler<DeleteNotificationRuleRequest,DeleteNotificationRuleResult> asyncHandler)
AWSCodeStarNotificationsAsyncDeletes a notification rule for a resource.
deleteNotificationRuleAsync in interface AWSCodeStarNotificationsAsyncasyncHandler - 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.public Future<DeleteTargetResult> deleteTargetAsync(DeleteTargetRequest request)
AWSCodeStarNotificationsAsyncDeletes a specified target for notifications.
deleteTargetAsync in interface AWSCodeStarNotificationsAsyncpublic Future<DeleteTargetResult> deleteTargetAsync(DeleteTargetRequest request, AsyncHandler<DeleteTargetRequest,DeleteTargetResult> asyncHandler)
AWSCodeStarNotificationsAsyncDeletes a specified target for notifications.
deleteTargetAsync in interface AWSCodeStarNotificationsAsyncasyncHandler - 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.public Future<DescribeNotificationRuleResult> describeNotificationRuleAsync(DescribeNotificationRuleRequest request)
AWSCodeStarNotificationsAsyncReturns information about a specified notification rule.
describeNotificationRuleAsync in interface AWSCodeStarNotificationsAsyncpublic Future<DescribeNotificationRuleResult> describeNotificationRuleAsync(DescribeNotificationRuleRequest request, AsyncHandler<DescribeNotificationRuleRequest,DescribeNotificationRuleResult> asyncHandler)
AWSCodeStarNotificationsAsyncReturns information about a specified notification rule.
describeNotificationRuleAsync in interface AWSCodeStarNotificationsAsyncasyncHandler - 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.public Future<ListEventTypesResult> listEventTypesAsync(ListEventTypesRequest request)
AWSCodeStarNotificationsAsyncReturns information about the event types available for configuring notifications.
listEventTypesAsync in interface AWSCodeStarNotificationsAsyncpublic Future<ListEventTypesResult> listEventTypesAsync(ListEventTypesRequest request, AsyncHandler<ListEventTypesRequest,ListEventTypesResult> asyncHandler)
AWSCodeStarNotificationsAsyncReturns information about the event types available for configuring notifications.
listEventTypesAsync in interface AWSCodeStarNotificationsAsyncasyncHandler - 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.public Future<ListNotificationRulesResult> listNotificationRulesAsync(ListNotificationRulesRequest request)
AWSCodeStarNotificationsAsyncReturns a list of the notification rules for an Amazon Web Services account.
listNotificationRulesAsync in interface AWSCodeStarNotificationsAsyncpublic Future<ListNotificationRulesResult> listNotificationRulesAsync(ListNotificationRulesRequest request, AsyncHandler<ListNotificationRulesRequest,ListNotificationRulesResult> asyncHandler)
AWSCodeStarNotificationsAsyncReturns a list of the notification rules for an Amazon Web Services account.
listNotificationRulesAsync in interface AWSCodeStarNotificationsAsyncasyncHandler - 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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSCodeStarNotificationsAsyncReturns a list of the tags associated with a notification rule.
listTagsForResourceAsync in interface AWSCodeStarNotificationsAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSCodeStarNotificationsAsyncReturns a list of the tags associated with a notification rule.
listTagsForResourceAsync in interface AWSCodeStarNotificationsAsyncasyncHandler - 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.public Future<ListTargetsResult> listTargetsAsync(ListTargetsRequest request)
AWSCodeStarNotificationsAsyncReturns a list of the notification rule targets for an Amazon Web Services account.
listTargetsAsync in interface AWSCodeStarNotificationsAsyncpublic Future<ListTargetsResult> listTargetsAsync(ListTargetsRequest request, AsyncHandler<ListTargetsRequest,ListTargetsResult> asyncHandler)
AWSCodeStarNotificationsAsyncReturns a list of the notification rule targets for an Amazon Web Services account.
listTargetsAsync in interface AWSCodeStarNotificationsAsyncasyncHandler - 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.public Future<SubscribeResult> subscribeAsync(SubscribeRequest request)
AWSCodeStarNotificationsAsyncCreates 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.
subscribeAsync in interface AWSCodeStarNotificationsAsyncpublic Future<SubscribeResult> subscribeAsync(SubscribeRequest request, AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
AWSCodeStarNotificationsAsyncCreates 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.
subscribeAsync in interface AWSCodeStarNotificationsAsyncasyncHandler - 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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSCodeStarNotificationsAsyncAssociates a set of provided tags with a notification rule.
tagResourceAsync in interface AWSCodeStarNotificationsAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSCodeStarNotificationsAsyncAssociates a set of provided tags with a notification rule.
tagResourceAsync in interface AWSCodeStarNotificationsAsyncasyncHandler - 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.public Future<UnsubscribeResult> unsubscribeAsync(UnsubscribeRequest request)
AWSCodeStarNotificationsAsyncRemoves 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.
unsubscribeAsync in interface AWSCodeStarNotificationsAsyncpublic Future<UnsubscribeResult> unsubscribeAsync(UnsubscribeRequest request, AsyncHandler<UnsubscribeRequest,UnsubscribeResult> asyncHandler)
AWSCodeStarNotificationsAsyncRemoves 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.
unsubscribeAsync in interface AWSCodeStarNotificationsAsyncasyncHandler - 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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSCodeStarNotificationsAsyncRemoves the association between one or more provided tags and a notification rule.
untagResourceAsync in interface AWSCodeStarNotificationsAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSCodeStarNotificationsAsyncRemoves the association between one or more provided tags and a notification rule.
untagResourceAsync in interface AWSCodeStarNotificationsAsyncasyncHandler - 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.public Future<UpdateNotificationRuleResult> updateNotificationRuleAsync(UpdateNotificationRuleRequest request)
AWSCodeStarNotificationsAsyncUpdates 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.
updateNotificationRuleAsync in interface AWSCodeStarNotificationsAsyncpublic Future<UpdateNotificationRuleResult> updateNotificationRuleAsync(UpdateNotificationRuleRequest request, AsyncHandler<UpdateNotificationRuleRequest,UpdateNotificationRuleResult> asyncHandler)
AWSCodeStarNotificationsAsyncUpdates 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.
updateNotificationRuleAsync in interface AWSCodeStarNotificationsAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSCodeStarNotificationsshutdown in class AWSCodeStarNotificationsClient