com.amazonaws.services.codestarnotifications.AWSCodeStarNotificationsAsync Maven / Gradle / Ivy
/*
* Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.codestarnotifications;
import javax.annotation.Generated;
import com.amazonaws.services.codestarnotifications.model.*;
/**
* Interface for accessing AWS CodeStar Notifications asynchronously. Each asynchronous method will return a Java Future
* object representing the asynchronous operation; overloads which accept an {@code 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
* {@link com.amazonaws.services.codestarnotifications.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCodeStarNotificationsAsync extends AWSCodeStarNotifications {
/**
*
* 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.
*
*
* @param createNotificationRuleRequest
* @return A Java Future containing the result of the CreateNotificationRule operation returned by the service.
* @sample AWSCodeStarNotificationsAsync.CreateNotificationRule
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param createNotificationRuleRequest
* @param 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.
* @return A Java Future containing the result of the CreateNotificationRule operation returned by the service.
* @sample AWSCodeStarNotificationsAsyncHandler.CreateNotificationRule
* @see AWS API Documentation
*/
java.util.concurrent.Future createNotificationRuleAsync(CreateNotificationRuleRequest createNotificationRuleRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a notification rule for a resource.
*
*
* @param deleteNotificationRuleRequest
* @return A Java Future containing the result of the DeleteNotificationRule operation returned by the service.
* @sample AWSCodeStarNotificationsAsync.DeleteNotificationRule
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteNotificationRuleAsync(DeleteNotificationRuleRequest deleteNotificationRuleRequest);
/**
*
* Deletes a notification rule for a resource.
*
*
* @param deleteNotificationRuleRequest
* @param 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.
* @return A Java Future containing the result of the DeleteNotificationRule operation returned by the service.
* @sample AWSCodeStarNotificationsAsyncHandler.DeleteNotificationRule
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteNotificationRuleAsync(DeleteNotificationRuleRequest deleteNotificationRuleRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a specified target for notifications.
*
*
* @param deleteTargetRequest
* @return A Java Future containing the result of the DeleteTarget operation returned by the service.
* @sample AWSCodeStarNotificationsAsync.DeleteTarget
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteTargetAsync(DeleteTargetRequest deleteTargetRequest);
/**
*
* Deletes a specified target for notifications.
*
*
* @param deleteTargetRequest
* @param 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.
* @return A Java Future containing the result of the DeleteTarget operation returned by the service.
* @sample AWSCodeStarNotificationsAsyncHandler.DeleteTarget
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteTargetAsync(DeleteTargetRequest deleteTargetRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns information about a specified notification rule.
*
*
* @param describeNotificationRuleRequest
* @return A Java Future containing the result of the DescribeNotificationRule operation returned by the service.
* @sample AWSCodeStarNotificationsAsync.DescribeNotificationRule
* @see AWS API Documentation
*/
java.util.concurrent.Future describeNotificationRuleAsync(DescribeNotificationRuleRequest describeNotificationRuleRequest);
/**
*
* Returns information about a specified notification rule.
*
*
* @param describeNotificationRuleRequest
* @param 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.
* @return A Java Future containing the result of the DescribeNotificationRule operation returned by the service.
* @sample AWSCodeStarNotificationsAsyncHandler.DescribeNotificationRule
* @see AWS API Documentation
*/
java.util.concurrent.Future describeNotificationRuleAsync(DescribeNotificationRuleRequest describeNotificationRuleRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns information about the event types available for configuring notifications.
*
*
* @param listEventTypesRequest
* @return A Java Future containing the result of the ListEventTypes operation returned by the service.
* @sample AWSCodeStarNotificationsAsync.ListEventTypes
* @see AWS API Documentation
*/
java.util.concurrent.Future listEventTypesAsync(ListEventTypesRequest listEventTypesRequest);
/**
*
* Returns information about the event types available for configuring notifications.
*
*
* @param listEventTypesRequest
* @param 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.
* @return A Java Future containing the result of the ListEventTypes operation returned by the service.
* @sample AWSCodeStarNotificationsAsyncHandler.ListEventTypes
* @see AWS API Documentation
*/
java.util.concurrent.Future listEventTypesAsync(ListEventTypesRequest listEventTypesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of the notification rules for an AWS account.
*
*
* @param listNotificationRulesRequest
* @return A Java Future containing the result of the ListNotificationRules operation returned by the service.
* @sample AWSCodeStarNotificationsAsync.ListNotificationRules
* @see AWS API Documentation
*/
java.util.concurrent.Future listNotificationRulesAsync(ListNotificationRulesRequest listNotificationRulesRequest);
/**
*
* Returns a list of the notification rules for an AWS account.
*
*
* @param listNotificationRulesRequest
* @param 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.
* @return A Java Future containing the result of the ListNotificationRules operation returned by the service.
* @sample AWSCodeStarNotificationsAsyncHandler.ListNotificationRules
* @see AWS API Documentation
*/
java.util.concurrent.Future listNotificationRulesAsync(ListNotificationRulesRequest listNotificationRulesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of the tags associated with a notification rule.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSCodeStarNotificationsAsync.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Returns a list of the tags associated with a notification rule.
*
*
* @param listTagsForResourceRequest
* @param 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.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSCodeStarNotificationsAsyncHandler.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of the notification rule targets for an AWS account.
*
*
* @param listTargetsRequest
* @return A Java Future containing the result of the ListTargets operation returned by the service.
* @sample AWSCodeStarNotificationsAsync.ListTargets
* @see AWS API Documentation
*/
java.util.concurrent.Future listTargetsAsync(ListTargetsRequest listTargetsRequest);
/**
*
* Returns a list of the notification rule targets for an AWS account.
*
*
* @param listTargetsRequest
* @param 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.
* @return A Java Future containing the result of the ListTargets operation returned by the service.
* @sample AWSCodeStarNotificationsAsyncHandler.ListTargets
* @see AWS API Documentation
*/
java.util.concurrent.Future listTargetsAsync(ListTargetsRequest listTargetsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param subscribeRequest
* @return A Java Future containing the result of the Subscribe operation returned by the service.
* @sample AWSCodeStarNotificationsAsync.Subscribe
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param subscribeRequest
* @param 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.
* @return A Java Future containing the result of the Subscribe operation returned by the service.
* @sample AWSCodeStarNotificationsAsyncHandler.Subscribe
* @see AWS API Documentation
*/
java.util.concurrent.Future subscribeAsync(SubscribeRequest subscribeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Associates a set of provided tags with a notification rule.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSCodeStarNotificationsAsync.TagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Associates a set of provided tags with a notification rule.
*
*
* @param tagResourceRequest
* @param 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.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSCodeStarNotificationsAsyncHandler.TagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param unsubscribeRequest
* @return A Java Future containing the result of the Unsubscribe operation returned by the service.
* @sample AWSCodeStarNotificationsAsync.Unsubscribe
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param unsubscribeRequest
* @param 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.
* @return A Java Future containing the result of the Unsubscribe operation returned by the service.
* @sample AWSCodeStarNotificationsAsyncHandler.Unsubscribe
* @see AWS API Documentation
*/
java.util.concurrent.Future unsubscribeAsync(UnsubscribeRequest unsubscribeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes the association between one or more provided tags and a notification rule.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSCodeStarNotificationsAsync.UntagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes the association between one or more provided tags and a notification rule.
*
*
* @param untagResourceRequest
* @param 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.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSCodeStarNotificationsAsyncHandler.UntagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
*
* @param updateNotificationRuleRequest
* @return A Java Future containing the result of the UpdateNotificationRule operation returned by the service.
* @sample AWSCodeStarNotificationsAsync.UpdateNotificationRule
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
*
* @param updateNotificationRuleRequest
* @param 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.
* @return A Java Future containing the result of the UpdateNotificationRule operation returned by the service.
* @sample AWSCodeStarNotificationsAsyncHandler.UpdateNotificationRule
* @see AWS API Documentation
*/
java.util.concurrent.Future updateNotificationRuleAsync(UpdateNotificationRuleRequest updateNotificationRuleRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}