Skip to content

Commit 5c923c2

Browse files
author
awstools
committed
feat(client-codestar-notifications): This release adds tag based access control for the UntagResource API.
1 parent 0da530b commit 5c923c2

File tree

11 files changed

+281
-200
lines changed

11 files changed

+281
-200
lines changed

clients/client-codestar-notifications/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ notification rule. </p>
5252
<ul>
5353
<li>
5454
<p>
55-
<a>DeleteTarget</a>, which removes a notification rule target (SNS topic) from a
55+
<a>DeleteTarget</a>, which removes a notification rule target from a
5656
notification rule. </p>
5757
</li>
5858
<li>
@@ -89,7 +89,7 @@ your account. </p>
8989
</li>
9090
</ul>
9191

92-
<p> For information about how to use AWS CodeStar Notifications, see link in the CodeStarNotifications User Guide.
92+
<p> For information about how to use AWS CodeStar Notifications, see the <a href="https://docs.aws.amazon.com/dtconsole/latest/userguide/what-is-dtconsole.html">Amazon Web Services Developer Tools Console User Guide</a>.
9393
</p>
9494

9595
## Installing

clients/client-codestar-notifications/src/CodestarNotifications.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ import {
9696
* <ul>
9797
* <li>
9898
* <p>
99-
* <a>DeleteTarget</a>, which removes a notification rule target (SNS topic) from a
99+
* <a>DeleteTarget</a>, which removes a notification rule target from a
100100
* notification rule. </p>
101101
* </li>
102102
* <li>
@@ -135,13 +135,13 @@ import {
135135
*
136136
*
137137
*
138-
* <p> For information about how to use AWS CodeStar Notifications, see link in the CodeStarNotifications User Guide.
138+
* <p> For information about how to use AWS CodeStar Notifications, see the <a href="https://docs.aws.amazon.com/dtconsole/latest/userguide/what-is-dtconsole.html">Amazon Web Services Developer Tools Console User Guide</a>.
139139
* </p>
140140
*/
141141
export class CodestarNotifications extends CodestarNotificationsClient {
142142
/**
143143
* <p>Creates a notification rule for a resource. The rule specifies the events you want
144-
* notifications about and the targets (such as SNS topics) where you want to receive
144+
* notifications about and the targets (such as Chatbot topics or Chatbot clients configured for Slack) where you want to receive
145145
* them.</p>
146146
*/
147147
public createNotificationRule(
@@ -299,7 +299,7 @@ export class CodestarNotifications extends CodestarNotificationsClient {
299299
}
300300

301301
/**
302-
* <p>Returns a list of the notification rules for an AWS account.</p>
302+
* <p>Returns a list of the notification rules for an Amazon Web Services account.</p>
303303
*/
304304
public listNotificationRules(
305305
args: ListNotificationRulesCommandInput,
@@ -363,7 +363,7 @@ export class CodestarNotifications extends CodestarNotificationsClient {
363363
}
364364

365365
/**
366-
* <p>Returns a list of the notification rule targets for an AWS account.</p>
366+
* <p>Returns a list of the notification rule targets for an Amazon Web Services account.</p>
367367
*/
368368
public listTargets(args: ListTargetsCommandInput, options?: __HttpHandlerOptions): Promise<ListTargetsCommandOutput>;
369369
public listTargets(args: ListTargetsCommandInput, cb: (err: any, data?: ListTargetsCommandOutput) => void): void;
@@ -389,7 +389,7 @@ export class CodestarNotifications extends CodestarNotificationsClient {
389389
}
390390

391391
/**
392-
* <p>Creates an association between a notification rule and an SNS topic so that the
392+
* <p>Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the
393393
* associated target can receive notifications when the events described in the rule are
394394
* triggered.</p>
395395
*/
@@ -443,7 +443,7 @@ export class CodestarNotifications extends CodestarNotificationsClient {
443443
}
444444

445445
/**
446-
* <p>Removes an association between a notification rule and an Amazon SNS topic so that
446+
* <p>Removes an association between a notification rule and an Chatbot topic so that
447447
* subscribers to that topic stop receiving notifications when the events described in the
448448
* rule are triggered.</p>
449449
*/

clients/client-codestar-notifications/src/CodestarNotificationsClient.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ export interface CodestarNotificationsClientResolvedConfig extends CodestarNotif
313313
* <ul>
314314
* <li>
315315
* <p>
316-
* <a>DeleteTarget</a>, which removes a notification rule target (SNS topic) from a
316+
* <a>DeleteTarget</a>, which removes a notification rule target from a
317317
* notification rule. </p>
318318
* </li>
319319
* <li>
@@ -352,7 +352,7 @@ export interface CodestarNotificationsClientResolvedConfig extends CodestarNotif
352352
*
353353
*
354354
*
355-
* <p> For information about how to use AWS CodeStar Notifications, see link in the CodeStarNotifications User Guide.
355+
* <p> For information about how to use AWS CodeStar Notifications, see the <a href="https://docs.aws.amazon.com/dtconsole/latest/userguide/what-is-dtconsole.html">Amazon Web Services Developer Tools Console User Guide</a>.
356356
* </p>
357357
*/
358358
export class CodestarNotificationsClient extends __Client<

clients/client-codestar-notifications/src/commands/CreateNotificationRuleCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface CreateNotificationRuleCommandOutput extends CreateNotificationR
3333

3434
/**
3535
* <p>Creates a notification rule for a resource. The rule specifies the events you want
36-
* notifications about and the targets (such as SNS topics) where you want to receive
36+
* notifications about and the targets (such as Chatbot topics or Chatbot clients configured for Slack) where you want to receive
3737
* them.</p>
3838
* @example
3939
* Use a bare-bones client and the command you need to make an API call.

clients/client-codestar-notifications/src/commands/ListNotificationRulesCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface ListNotificationRulesCommandInput extends ListNotificationRules
3232
export interface ListNotificationRulesCommandOutput extends ListNotificationRulesResult, __MetadataBearer {}
3333

3434
/**
35-
* <p>Returns a list of the notification rules for an AWS account.</p>
35+
* <p>Returns a list of the notification rules for an Amazon Web Services account.</p>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
3838
* ```javascript

clients/client-codestar-notifications/src/commands/ListTargetsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface ListTargetsCommandInput extends ListTargetsRequest {}
3232
export interface ListTargetsCommandOutput extends ListTargetsResult, __MetadataBearer {}
3333

3434
/**
35-
* <p>Returns a list of the notification rule targets for an AWS account.</p>
35+
* <p>Returns a list of the notification rule targets for an Amazon Web Services account.</p>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
3838
* ```javascript

clients/client-codestar-notifications/src/commands/SubscribeCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface SubscribeCommandInput extends SubscribeRequest {}
3232
export interface SubscribeCommandOutput extends SubscribeResult, __MetadataBearer {}
3333

3434
/**
35-
* <p>Creates an association between a notification rule and an SNS topic so that the
35+
* <p>Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the
3636
* associated target can receive notifications when the events described in the rule are
3737
* triggered.</p>
3838
* @example

clients/client-codestar-notifications/src/commands/UnsubscribeCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface UnsubscribeCommandInput extends UnsubscribeRequest {}
3232
export interface UnsubscribeCommandOutput extends UnsubscribeResult, __MetadataBearer {}
3333

3434
/**
35-
* <p>Removes an association between a notification rule and an Amazon SNS topic so that
35+
* <p>Removes an association between a notification rule and an Chatbot topic so that
3636
* subscribers to that topic stop receiving notifications when the events described in the
3737
* rule are triggered.</p>
3838
* @example

clients/client-codestar-notifications/src/models/models_0.ts

Lines changed: 53 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -79,24 +79,31 @@ export enum NotificationRuleStatus {
7979
}
8080

8181
/**
82-
* <p>Information about the SNS topics associated with a notification rule.</p>
82+
* <p>Information about the Chatbot topics or Chatbot clients associated with a notification rule.</p>
8383
*/
8484
export interface Target {
8585
/**
86-
* <p>The target type. Can be an Amazon SNS topic.</p>
86+
* <p>The target type. Can be an Chatbot topic or Chatbot client.</p>
87+
* <ul>
88+
* <li>
89+
* <p>Chatbot topics are specified as <code>SNS</code>.</p>
90+
* </li>
91+
* <li>
92+
* <p>Chatbot clients are specified as <code>AWSChatbotSlack</code>.</p>
93+
* </li>
94+
* </ul>
8795
*/
8896
TargetType?: string;
8997

9098
/**
91-
* <p>The Amazon Resource Name (ARN) of the SNS topic.</p>
99+
* <p>The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.</p>
92100
*/
93101
TargetAddress?: string;
94102
}
95103

96104
export interface CreateNotificationRuleRequest {
97105
/**
98-
* <p>The name for the notification rule. Notifictaion rule names must be unique in your AWS
99-
* account.</p>
106+
* <p>The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.</p>
100107
*/
101108
Name: string | undefined;
102109

@@ -107,20 +114,20 @@ export interface CreateNotificationRuleRequest {
107114
EventTypeIds: string[] | undefined;
108115

109116
/**
110-
* <p>The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in AWS CodePipeline,
111-
* repositories in AWS CodeCommit, and build projects in AWS CodeBuild.</p>
117+
* <p>The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in CodePipeline,
118+
* repositories in CodeCommit, and build projects in CodeBuild.</p>
112119
*/
113120
Resource: string | undefined;
114121

115122
/**
116-
* <p>A list of Amazon Resource Names (ARNs) of SNS topics to associate with the
123+
* <p>A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the
117124
* notification rule.</p>
118125
*/
119126
Targets: Target[] | undefined;
120127

121128
/**
122-
* <p>The level of detail to include in the notifications for this resource. BASIC will include only the
123-
* contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information
129+
* <p>The level of detail to include in the notifications for this resource. <code>BASIC</code> will include only the
130+
* contents of the event as it would appear in Amazon CloudWatch. <code>FULL</code> will include any supplemental information
124131
* provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.</p>
125132
*/
126133
DetailType: DetailType | string | undefined;
@@ -131,20 +138,20 @@ export interface CreateNotificationRuleRequest {
131138
* parameters is received and a token is included, the request returns information about
132139
* the initial request that used that token.</p>
133140
* <note>
134-
* <p>The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an
141+
* <p>The Amazon Web Services SDKs prepopulate client request tokens. If you are using an Amazon Web Services SDK, an
135142
* idempotency token is created for you.</p>
136143
* </note>
137144
*/
138145
ClientRequestToken?: string;
139146

140147
/**
141-
* <p>A list of tags to apply to this notification rule. Key names cannot start with "aws". </p>
148+
* <p>A list of tags to apply to this notification rule. Key names cannot start with "<code>aws</code>". </p>
142149
*/
143150
Tags?: Record<string, string>;
144151

145152
/**
146-
* <p>The status of the notification rule. The default value is ENABLED. If the status is
147-
* set to DISABLED, notifications aren't sent for the notification rule.</p>
153+
* <p>The status of the notification rule. The default value is <code>ENABLED</code>. If the status is
154+
* set to <code>DISABLED</code>, notifications aren't sent for the notification rule.</p>
148155
*/
149156
Status?: NotificationRuleStatus | string;
150157
}
@@ -181,7 +188,7 @@ export class LimitExceededException extends __BaseException {
181188

182189
/**
183190
* <p>A resource with the same name or ID already exists. Notification rule names must be
184-
* unique in your AWS account.</p>
191+
* unique in your Amazon Web Services account.</p>
185192
*/
186193
export class ResourceAlreadyExistsException extends __BaseException {
187194
readonly name: "ResourceAlreadyExistsException" = "ResourceAlreadyExistsException";
@@ -238,14 +245,14 @@ export interface DeleteNotificationRuleResult {
238245

239246
export interface DeleteTargetRequest {
240247
/**
241-
* <p>The Amazon Resource Name (ARN) of the SNS topic to delete.</p>
248+
* <p>The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client to delete.</p>
242249
*/
243250
TargetAddress: string | undefined;
244251

245252
/**
246-
* <p>A Boolean value that can be used to delete all associations with this SNS topic. The
253+
* <p>A Boolean value that can be used to delete all associations with this Chatbot topic. The
247254
* default value is FALSE. If set to TRUE, all associations between that target and every
248-
* notification rule in your AWS account are deleted.</p>
255+
* notification rule in your Amazon Web Services account are deleted.</p>
249256
*/
250257
ForceUnsubscribeAll?: boolean;
251258
}
@@ -264,7 +271,9 @@ export interface DescribeNotificationRuleRequest {
264271
*/
265272
export interface EventTypeSummary {
266273
/**
267-
* <p>The system-generated ID of the event.</p>
274+
* <p>The system-generated ID of the event. For a complete list of event types and IDs, see
275+
* <a href="https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api">Notification concepts</a>
276+
* in the <i>Developer Tools Console User Guide</i>.</p>
268277
*/
269278
EventTypeId?: string;
270279

@@ -297,12 +306,20 @@ export enum TargetStatus {
297306
*/
298307
export interface TargetSummary {
299308
/**
300-
* <p>The Amazon Resource Name (ARN) of the SNS topic.</p>
309+
* <p>The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.</p>
301310
*/
302311
TargetAddress?: string;
303312

304313
/**
305-
* <p>The type of the target (for example, SNS).</p>
314+
* <p>The type of the target (for example, <code>SNS</code>).</p>
315+
* <ul>
316+
* <li>
317+
* <p>Chatbot topics are specified as <code>SNS</code>.</p>
318+
* </li>
319+
* <li>
320+
* <p>Chatbot clients are specified as <code>AWSChatbotSlack</code>.</p>
321+
* </li>
322+
* </ul>
306323
*/
307324
TargetType?: string;
308325

@@ -335,13 +352,13 @@ export interface DescribeNotificationRuleResult {
335352
Resource?: string;
336353

337354
/**
338-
* <p>A list of the SNS topics associated with the notification rule.</p>
355+
* <p>A list of the Chatbot topics and Chatbot clients associated with the notification rule.</p>
339356
*/
340357
Targets?: TargetSummary[];
341358

342359
/**
343360
* <p>The level of detail included in the notifications for this resource. BASIC will include only the
344-
* contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information
361+
* contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information
345362
* provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.</p>
346363
*/
347364
DetailType?: DetailType | string;
@@ -489,7 +506,7 @@ export interface ListNotificationRulesFilter {
489506

490507
/**
491508
* <p>The value of the attribute you want to use to filter the returned notification rules. For example, if you specify filtering by <i>RESOURCE</i>
492-
* in Name, you might specify the ARN of a pipeline in AWS CodePipeline for the value.</p>
509+
* in Name, you might specify the ARN of a pipeline in CodePipeline for the value.</p>
493510
*/
494511
Value: string | undefined;
495512
}
@@ -539,7 +556,7 @@ export interface ListNotificationRulesResult {
539556
NextToken?: string;
540557

541558
/**
542-
* <p>The list of notification rules for the AWS account, by Amazon Resource Name (ARN) and ID. </p>
559+
* <p>The list of notification rules for the Amazon Web Services account, by Amazon Resource Name (ARN) and ID. </p>
543560
*/
544561
NotificationRules?: NotificationRuleSummary[];
545562
}
@@ -567,9 +584,9 @@ export enum ListTargetsFilterName {
567584
/**
568585
* <p>Information about a filter to apply to the list of returned targets. You can filter by
569586
* target type, address, or status. For example, to filter results to notification rules
570-
* that have active Amazon SNS topics as targets, you could specify a ListTargetsFilter
571-
* Name as TargetType and a Value of SNS, and a Name of TARGET_STATUS and a Value of
572-
* ACTIVE.</p>
587+
* that have active Chatbot topics as targets, you could specify a ListTargetsFilter
588+
* Name as <code>TargetType</code> and a Value of <code>SNS</code>, and a Name of <code>TARGET_STATUS</code> and a Value of
589+
* <code>ACTIVE</code>.</p>
573590
*/
574591
export interface ListTargetsFilter {
575592
/**
@@ -579,7 +596,7 @@ export interface ListTargetsFilter {
579596

580597
/**
581598
* <p>The value of the attribute you want to use to filter the returned targets. For example,
582-
* if you specify <i>SNS</i> for the Target type, you could specify an Amazon
599+
* if you specify <code>SNS</code> for the Target type, you could specify an Amazon
583600
* Resource Name (ARN) for a topic as the value.</p>
584601
*/
585602
Value: string | undefined;
@@ -628,7 +645,7 @@ export interface SubscribeRequest {
628645
Arn: string | undefined;
629646

630647
/**
631-
* <p>Information about the SNS topics associated with a notification rule.</p>
648+
* <p>Information about the Chatbot topics or Chatbot clients associated with a notification rule.</p>
632649
*/
633650
Target: Target | undefined;
634651

@@ -653,7 +670,7 @@ export interface TagResourceRequest {
653670
Arn: string | undefined;
654671

655672
/**
656-
* <p>The list of tags to associate with the resource. Tag key names cannot start with "aws".</p>
673+
* <p>The list of tags to associate with the resource. Tag key names cannot start with "<code>aws</code>".</p>
657674
*/
658675
Tags: Record<string, string> | undefined;
659676
}
@@ -672,7 +689,7 @@ export interface UnsubscribeRequest {
672689
Arn: string | undefined;
673690

674691
/**
675-
* <p>The ARN of the SNS topic to unsubscribe from the notification rule.</p>
692+
* <p>The ARN of the Chatbot topic to unsubscribe from the notification rule.</p>
676693
*/
677694
TargetAddress: string | undefined;
678695
}
@@ -717,7 +734,9 @@ export interface UpdateNotificationRuleRequest {
717734
Status?: NotificationRuleStatus | string;
718735

719736
/**
720-
* <p>A list of event types associated with this notification rule.</p>
737+
* <p>A list of event types associated with this notification rule. For a complete list of event types and IDs, see
738+
* <a href="https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api">Notification concepts</a>
739+
* in the <i>Developer Tools Console User Guide</i>.</p>
721740
*/
722741
EventTypeIds?: string[];
723742

@@ -729,7 +748,7 @@ export interface UpdateNotificationRuleRequest {
729748

730749
/**
731750
* <p>The level of detail to include in the notifications for this resource. BASIC will include only the
732-
* contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information
751+
* contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information
733752
* provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.</p>
734753
*/
735754
DetailType?: DetailType | string;

0 commit comments

Comments
 (0)