/* * Copyright 2018-2023 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 org.w3c.dom.*; import java.net.*; import java.util.*; import javax.annotation.Generated; import org.apache.commons.logging.*; import com.amazonaws.*; import com.amazonaws.annotation.SdkInternalApi; import com.amazonaws.auth.*; import com.amazonaws.handlers.*; import com.amazonaws.http.*; import com.amazonaws.internal.*; import com.amazonaws.internal.auth.*; import com.amazonaws.metrics.*; import com.amazonaws.regions.*; import com.amazonaws.transform.*; import com.amazonaws.util.*; import com.amazonaws.protocol.json.*; import com.amazonaws.util.AWSRequestMetrics.Field; import com.amazonaws.annotation.ThreadSafe; import com.amazonaws.client.AwsSyncClientParams; import com.amazonaws.client.builder.AdvancedConfig; import com.amazonaws.services.codestarnotifications.AWSCodeStarNotificationsClientBuilder; import com.amazonaws.AmazonServiceException; import com.amazonaws.services.codestarnotifications.model.*; import com.amazonaws.services.codestarnotifications.model.transform.*; /** * 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. *
*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AWSCodeStarNotificationsClient extends AmazonWebServiceClient implements AWSCodeStarNotifications { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AWSCodeStarNotifications.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "codestar-notifications"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .withContentTypeOverride("application/json") .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ConcurrentModificationException").withExceptionUnmarshaller( com.amazonaws.services.codestarnotifications.model.transform.ConcurrentModificationExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("AccessDeniedException").withExceptionUnmarshaller( com.amazonaws.services.codestarnotifications.model.transform.AccessDeniedExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ValidationException").withExceptionUnmarshaller( com.amazonaws.services.codestarnotifications.model.transform.ValidationExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ConfigurationException").withExceptionUnmarshaller( com.amazonaws.services.codestarnotifications.model.transform.ConfigurationExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.codestarnotifications.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceAlreadyExistsException").withExceptionUnmarshaller( com.amazonaws.services.codestarnotifications.model.transform.ResourceAlreadyExistsExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidNextTokenException").withExceptionUnmarshaller( com.amazonaws.services.codestarnotifications.model.transform.InvalidNextTokenExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("LimitExceededException").withExceptionUnmarshaller( com.amazonaws.services.codestarnotifications.model.transform.LimitExceededExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.codestarnotifications.model.AWSCodeStarNotificationsException.class)); public static AWSCodeStarNotificationsClientBuilder builder() { return AWSCodeStarNotificationsClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on AWS CodeStar Notifications using the specified parameters. * ** All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSCodeStarNotificationsClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on AWS CodeStar Notifications using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSCodeStarNotificationsClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("codestar-notifications.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/codestarnotifications/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/codestarnotifications/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* 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. *
* * @param createNotificationRuleRequest * @return 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. * @throws ValidationException * One or more parameter values are not valid. * @throws 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. * @throws ConfigurationException * Some or all of the configuration is incomplete, missing, or not valid. * @throws 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. * @throws AccessDeniedException * AWS CodeStar Notifications can't create the notification rule because you do not have sufficient * permissions. * @sample AWSCodeStarNotifications.CreateNotificationRule * @see AWS API Documentation */ @Override public CreateNotificationRuleResult createNotificationRule(CreateNotificationRuleRequest request) { request = beforeClientExecution(request); return executeCreateNotificationRule(request); } @SdkInternalApi final CreateNotificationRuleResult executeCreateNotificationRule(CreateNotificationRuleRequest createNotificationRuleRequest) { ExecutionContext executionContext = createExecutionContext(createNotificationRuleRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Deletes a notification rule for a resource. *
* * @param deleteNotificationRuleRequest * @return Result of the DeleteNotificationRule operation returned by the service. * @throws ValidationException * One or more parameter values are not valid. * @throws 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. * @throws 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. * @sample AWSCodeStarNotifications.DeleteNotificationRule * @see AWS API Documentation */ @Override public DeleteNotificationRuleResult deleteNotificationRule(DeleteNotificationRuleRequest request) { request = beforeClientExecution(request); return executeDeleteNotificationRule(request); } @SdkInternalApi final DeleteNotificationRuleResult executeDeleteNotificationRule(DeleteNotificationRuleRequest deleteNotificationRuleRequest) { ExecutionContext executionContext = createExecutionContext(deleteNotificationRuleRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Deletes a specified target for notifications. *
* * @param deleteTargetRequest * @return Result of the DeleteTarget operation returned by the service. * @throws ValidationException * One or more parameter values are not valid. * @sample AWSCodeStarNotifications.DeleteTarget * @see AWS API Documentation */ @Override public DeleteTargetResult deleteTarget(DeleteTargetRequest request) { request = beforeClientExecution(request); return executeDeleteTarget(request); } @SdkInternalApi final DeleteTargetResult executeDeleteTarget(DeleteTargetRequest deleteTargetRequest) { ExecutionContext executionContext = createExecutionContext(deleteTargetRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Returns information about a specified notification rule. *
* * @param describeNotificationRuleRequest * @return Result of the DescribeNotificationRule operation returned by the service. * @throws ResourceNotFoundException * AWS CodeStar Notifications can't find a resource that matches the provided ARN. * @throws ValidationException * One or more parameter values are not valid. * @sample AWSCodeStarNotifications.DescribeNotificationRule * @see AWS API Documentation */ @Override public DescribeNotificationRuleResult describeNotificationRule(DescribeNotificationRuleRequest request) { request = beforeClientExecution(request); return executeDescribeNotificationRule(request); } @SdkInternalApi final DescribeNotificationRuleResult executeDescribeNotificationRule(DescribeNotificationRuleRequest describeNotificationRuleRequest) { ExecutionContext executionContext = createExecutionContext(describeNotificationRuleRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Returns information about the event types available for configuring notifications. *
* * @param listEventTypesRequest * @return 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. * @throws ValidationException * One or more parameter values are not valid. * @sample AWSCodeStarNotifications.ListEventTypes * @see AWS API Documentation */ @Override public ListEventTypesResult listEventTypes(ListEventTypesRequest request) { request = beforeClientExecution(request); return executeListEventTypes(request); } @SdkInternalApi final ListEventTypesResult executeListEventTypes(ListEventTypesRequest listEventTypesRequest) { ExecutionContext executionContext = createExecutionContext(listEventTypesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Returns a list of the notification rules for an Amazon Web Services account. *
* * @param listNotificationRulesRequest * @return 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. * @throws ValidationException * One or more parameter values are not valid. * @sample AWSCodeStarNotifications.ListNotificationRules * @see AWS API Documentation */ @Override public ListNotificationRulesResult listNotificationRules(ListNotificationRulesRequest request) { request = beforeClientExecution(request); return executeListNotificationRules(request); } @SdkInternalApi final ListNotificationRulesResult executeListNotificationRules(ListNotificationRulesRequest listNotificationRulesRequest) { ExecutionContext executionContext = createExecutionContext(listNotificationRulesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Returns a list of the tags associated with a notification rule. *
* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws ResourceNotFoundException * AWS CodeStar Notifications can't find a resource that matches the provided ARN. * @throws ValidationException * One or more parameter values are not valid. * @sample AWSCodeStarNotifications.ListTagsForResource * @see AWS API Documentation */ @Override public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request) { request = beforeClientExecution(request); return executeListTagsForResource(request); } @SdkInternalApi final ListTagsForResourceResult executeListTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) { ExecutionContext executionContext = createExecutionContext(listTagsForResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Returns a list of the notification rule targets for an Amazon Web Services account. *
* * @param listTargetsRequest * @return 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. * @throws ValidationException * One or more parameter values are not valid. * @sample AWSCodeStarNotifications.ListTargets * @see AWS API Documentation */ @Override public ListTargetsResult listTargets(ListTargetsRequest request) { request = beforeClientExecution(request); return executeListTargets(request); } @SdkInternalApi final ListTargetsResult executeListTargets(ListTargetsRequest listTargetsRequest) { ExecutionContext executionContext = createExecutionContext(listTargetsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); 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. *
* * @param subscribeRequest * @return Result of the Subscribe operation returned by the service. * @throws ValidationException * One or more parameter values are not valid. * @throws ResourceNotFoundException * AWS CodeStar Notifications can't find a resource that matches the provided ARN. * @throws ConfigurationException * Some or all of the configuration is incomplete, missing, or not valid. * @sample AWSCodeStarNotifications.Subscribe * @see AWS API Documentation */ @Override public SubscribeResult subscribe(SubscribeRequest request) { request = beforeClientExecution(request); return executeSubscribe(request); } @SdkInternalApi final SubscribeResult executeSubscribe(SubscribeRequest subscribeRequest) { ExecutionContext executionContext = createExecutionContext(subscribeRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Associates a set of provided tags with a notification rule. *
* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws ResourceNotFoundException * AWS CodeStar Notifications can't find a resource that matches the provided ARN. * @throws 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. * @throws ValidationException * One or more parameter values are not valid. * @throws 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. * @sample AWSCodeStarNotifications.TagResource * @see AWS API Documentation */ @Override public TagResourceResult tagResource(TagResourceRequest request) { request = beforeClientExecution(request); return executeTagResource(request); } @SdkInternalApi final TagResourceResult executeTagResource(TagResourceRequest tagResourceRequest) { ExecutionContext executionContext = createExecutionContext(tagResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); 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. *
* * @param unsubscribeRequest * @return Result of the Unsubscribe operation returned by the service. * @throws ValidationException * One or more parameter values are not valid. * @sample AWSCodeStarNotifications.Unsubscribe * @see AWS API Documentation */ @Override public UnsubscribeResult unsubscribe(UnsubscribeRequest request) { request = beforeClientExecution(request); return executeUnsubscribe(request); } @SdkInternalApi final UnsubscribeResult executeUnsubscribe(UnsubscribeRequest unsubscribeRequest) { ExecutionContext executionContext = createExecutionContext(unsubscribeRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Removes the association between one or more provided tags and a notification rule. *
* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws ResourceNotFoundException * AWS CodeStar Notifications can't find a resource that matches the provided ARN. * @throws 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. * @throws ValidationException * One or more parameter values are not valid. * @throws 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. * @sample AWSCodeStarNotifications.UntagResource * @see AWS API Documentation */ @Override public UntagResourceResult untagResource(UntagResourceRequest request) { request = beforeClientExecution(request); return executeUntagResource(request); } @SdkInternalApi final UntagResourceResult executeUntagResource(UntagResourceRequest untagResourceRequest) { ExecutionContext executionContext = createExecutionContext(untagResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); 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. *
*
* 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.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private