com.amazonaws.services.codestarnotifications

Interface AWSCodeStarNotifications

All Known Subinterfaces:

AWSCodeStarNotificationsAsync

All Known Implementing Classes:

AbstractAWSCodeStarNotifications, AbstractAWSCodeStarNotificationsAsync, AWSCodeStarNotificationsAsyncClient, AWSCodeStarNotificationsClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCodeStarNotifications

Interface for accessing AWS CodeStar Notifications.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCodeStarNotifications 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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateNotificationRuleResult	createNotificationRule(CreateNotificationRuleRequest createNotificationRuleRequest) Creates a notification rule for a resource.
DeleteNotificationRuleResult	deleteNotificationRule(DeleteNotificationRuleRequest deleteNotificationRuleRequest) Deletes a notification rule for a resource.
DeleteTargetResult	deleteTarget(DeleteTargetRequest deleteTargetRequest) Deletes a specified target for notifications.
DescribeNotificationRuleResult	describeNotificationRule(DescribeNotificationRuleRequest describeNotificationRuleRequest) 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 listEventTypesRequest) Returns information about the event types available for configuring notifications.
ListNotificationRulesResult	listNotificationRules(ListNotificationRulesRequest listNotificationRulesRequest) Returns a list of the notification rules for an AWS account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of the tags associated with a notification rule.
ListTargetsResult	listTargets(ListTargetsRequest listTargetsRequest) Returns a list of the notification rule targets for an AWS account.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
SubscribeResult	subscribe(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.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Associates a set of provided tags with a notification rule.
UnsubscribeResult	unsubscribe(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.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the association between one or more provided tags and a notification rule.
UpdateNotificationRuleResult	updateNotificationRule(UpdateNotificationRuleRequest updateNotificationRuleRequest) Updates a notification rule for a resource.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createNotificationRule

CreateNotificationRuleResult createNotificationRule(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:

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 AWS 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

DeleteNotificationRuleResult deleteNotificationRule(DeleteNotificationRuleRequest deleteNotificationRuleRequest)

Deletes a notification rule for a resource.

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

DeleteTargetResult deleteTarget(DeleteTargetRequest deleteTargetRequest)

Deletes a specified target for notifications.

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

DescribeNotificationRuleResult describeNotificationRule(DescribeNotificationRuleRequest describeNotificationRuleRequest)

Returns information about a specified notification rule.

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

ListEventTypesResult listEventTypes(ListEventTypesRequest listEventTypesRequest)

Returns information about the event types available for configuring notifications.

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

ListNotificationRulesResult listNotificationRules(ListNotificationRulesRequest listNotificationRulesRequest)

Returns a list of the notification rules for an AWS account.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Returns a list of the tags associated with a notification rule.

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

ListTargetsResult listTargets(ListTargetsRequest listTargetsRequest)

Returns a list of the notification rule targets for an AWS account.

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

SubscribeResult subscribe(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:

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Associates a set of provided tags with a notification rule.

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.

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

UnsubscribeResult unsubscribe(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:

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes the association between one or more provided tags and a notification rule.

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.

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

UpdateNotificationRuleResult updateNotificationRule(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:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.