@aws-sdk/client-codestar-notifications 3.379.1 → 3.382.0

package/dist-types/models/models_0.d.ts

@@ -71,6 +71,7 @@ export type NotificationRuleStatus = (typeof NotificationRuleStatus)[keyof typeo
  */
 export interface Target {
     /**
+     * @public
      * <p>The target type. Can be an Chatbot topic or Chatbot client.</p>
      *          <ul>
      *             <li>
@@ -83,6 +84,7 @@ export interface Target {
      */
     TargetType?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.</p>
      */
     TargetAddress?: string;
@@ -92,31 +94,37 @@ export interface Target {
  */
 export interface CreateNotificationRuleRequest {
     /**
+     * @public
      * <p>The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.</p>
      */
     Name: string | undefined;
     /**
+     * @public
      * <p>A list of event types associated with this notification rule. For a list of allowed
      *             events, see <a>EventTypeSummary</a>.</p>
      */
     EventTypeIds: string[] | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in CodePipeline,
      *       repositories in CodeCommit, and build projects in CodeBuild.</p>
      */
     Resource: string | undefined;
     /**
+     * @public
      * <p>A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the
      *       notification rule.</p>
      */
     Targets: Target[] | undefined;
     /**
+     * @public
      * <p>The level of detail to include in the notifications for this resource. <code>BASIC</code> will include only the
      *         contents of the event as it would appear in Amazon CloudWatch. <code>FULL</code> will include any supplemental information
      *         provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.</p>
      */
     DetailType: DetailType | string | undefined;
     /**
+     * @public
      * <p>A unique, client-generated idempotency token that, when provided in a request, ensures
      *             the request cannot be repeated with a changed parameter. If a request with the same
      *             parameters is received and a token is included, the request returns information about
@@ -128,10 +136,12 @@ export interface CreateNotificationRuleRequest {
      */
     ClientRequestToken?: string;
     /**
+     * @public
      * <p>A list of tags to apply to this notification rule. Key names cannot start with "<code>aws</code>". </p>
      */
     Tags?: Record<string, string>;
     /**
+     * @public
      * <p>The status of the notification rule. The default value is <code>ENABLED</code>. If the status is
      *             set to <code>DISABLED</code>, notifications aren't sent for the notification rule.</p>
      */
@@ -142,6 +152,7 @@ export interface CreateNotificationRuleRequest {
  */
 export interface CreateNotificationRuleResult {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule.</p>
      */
     Arn?: string;
@@ -193,6 +204,7 @@ export declare class ValidationException extends __BaseException {
  */
 export interface DeleteNotificationRuleRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule you want to delete.</p>
      */
     Arn: string | undefined;
@@ -202,6 +214,7 @@ export interface DeleteNotificationRuleRequest {
  */
 export interface DeleteNotificationRuleResult {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the deleted notification rule.</p>
      */
     Arn?: string;
@@ -211,10 +224,12 @@ export interface DeleteNotificationRuleResult {
  */
 export interface DeleteTargetRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client to delete.</p>
      */
     TargetAddress: string | undefined;
     /**
+     * @public
      * <p>A Boolean value that can be used to delete all associations with this Chatbot topic. The
      *             default value is FALSE. If set to TRUE, all associations between that target and every
      *             notification rule in your Amazon Web Services account are deleted.</p>
@@ -231,6 +246,7 @@ export interface DeleteTargetResult {
  */
 export interface DescribeNotificationRuleRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule.</p>
      */
     Arn: string | undefined;
@@ -241,20 +257,24 @@ export interface DescribeNotificationRuleRequest {
  */
 export interface EventTypeSummary {
     /**
+     * @public
      * <p>The system-generated ID of the event. For a complete list of event types and IDs, see
      *           <a href="https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api">Notification concepts</a>
      *           in the <i>Developer Tools Console User Guide</i>.</p>
      */
     EventTypeId?: string;
     /**
+     * @public
      * <p>The name of the service for which the event applies.</p>
      */
     ServiceName?: string;
     /**
+     * @public
      * <p>The name of the event.</p>
      */
     EventTypeName?: string;
     /**
+     * @public
      * <p>The resource type of the event.</p>
      */
     ResourceType?: string;
@@ -280,10 +300,12 @@ export type TargetStatus = (typeof TargetStatus)[keyof typeof TargetStatus];
  */
 export interface TargetSummary {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.</p>
      */
     TargetAddress?: string;
     /**
+     * @public
      * <p>The type of the target (for example, <code>SNS</code>).</p>
      *          <ul>
      *             <li>
@@ -296,6 +318,7 @@ export interface TargetSummary {
      */
     TargetType?: string;
     /**
+     * @public
      * <p>The status of the target.</p>
      */
     TargetStatus?: TargetStatus | string;
@@ -305,51 +328,62 @@ export interface TargetSummary {
  */
 export interface DescribeNotificationRuleResult {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule.</p>
      */
     Arn: string | undefined;
     /**
+     * @public
      * <p>The name of the notification rule.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>A list of the event types associated with the notification rule.</p>
      */
     EventTypes?: EventTypeSummary[];
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the resource associated with the notification
      *       rule.</p>
      */
     Resource?: string;
     /**
+     * @public
      * <p>A list of the Chatbot topics and Chatbot clients associated with the notification rule.</p>
      */
     Targets?: TargetSummary[];
     /**
+     * @public
      * <p>The level of detail included in the notifications for this resource. BASIC will include only the
      *             contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information
      *             provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.</p>
      */
     DetailType?: DetailType | string;
     /**
+     * @public
      * <p>The name or email alias of the person who created the notification rule.</p>
      */
     CreatedBy?: string;
     /**
+     * @public
      * <p>The status of the notification rule. Valid statuses are on (sending notifications) or off
      *       (not sending notifications).</p>
      */
     Status?: NotificationRuleStatus | string;
     /**
+     * @public
      * <p>The date and time the notification rule was created, in timestamp format.</p>
      */
     CreatedTimestamp?: Date;
     /**
+     * @public
      * <p>The date and time the notification rule was most recently updated, in timestamp
      *             format.</p>
      */
     LastModifiedTimestamp?: Date;
     /**
+     * @public
      * <p>The tags associated with the notification rule.</p>
      */
     Tags?: Record<string, string>;
@@ -399,10 +433,12 @@ export type ListEventTypesFilterName = (typeof ListEventTypesFilterName)[keyof t
  */
 export interface ListEventTypesFilter {
     /**
+     * @public
      * <p>The system-generated name of the filter type you want to filter by.</p>
      */
     Name: ListEventTypesFilterName | string | undefined;
     /**
+     * @public
      * <p>The name of the resource type (for example, pipeline) or service name (for example,
      *       CodePipeline) that you want to filter by.</p>
      */
@@ -413,15 +449,18 @@ export interface ListEventTypesFilter {
  */
 export interface ListEventTypesRequest {
     /**
+     * @public
      * <p>The filters to use to return information by service or resource type.</p>
      */
     Filters?: ListEventTypesFilter[];
     /**
+     * @public
      * <p>An enumeration token that, when provided in a request, returns the next batch of the
      *             results.</p>
      */
     NextToken?: string;
     /**
+     * @public
      * <p>A non-negative integer used to limit the number of returned results. The default number is 50. The maximum number of
      *       results that can be returned is 100.</p>
      */
@@ -432,11 +471,13 @@ export interface ListEventTypesRequest {
  */
 export interface ListEventTypesResult {
     /**
+     * @public
      * <p>Information about each event, including service name, resource type, event ID, and event
      *       name.</p>
      */
     EventTypes?: EventTypeSummary[];
     /**
+     * @public
      * <p>An enumeration token that can be used in a request to return the next batch of the results.</p>
      */
     NextToken?: string;
@@ -462,10 +503,12 @@ export type ListNotificationRulesFilterName = (typeof ListNotificationRulesFilte
  */
 export interface ListNotificationRulesFilter {
     /**
+     * @public
      * <p>The name of the attribute you want to use to filter the returned notification rules.</p>
      */
     Name: ListNotificationRulesFilterName | string | undefined;
     /**
+     * @public
      * <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>
      *           in Name, you might specify the ARN of a pipeline in CodePipeline for the value.</p>
      */
@@ -476,6 +519,7 @@ export interface ListNotificationRulesFilter {
  */
 export interface ListNotificationRulesRequest {
     /**
+     * @public
      * <p>The filters to use to return information by service or resource type. For valid values,
      *             see <a>ListNotificationRulesFilter</a>.</p>
      *          <note>
@@ -484,11 +528,13 @@ export interface ListNotificationRulesRequest {
      */
     Filters?: ListNotificationRulesFilter[];
     /**
+     * @public
      * <p>An enumeration token that, when provided in a request, returns the next batch of the
      *             results.</p>
      */
     NextToken?: string;
     /**
+     * @public
      * <p>A non-negative integer used to limit the number of returned results. The maximum number of
      *       results that can be returned is 100.</p>
      */
@@ -500,10 +546,12 @@ export interface ListNotificationRulesRequest {
  */
 export interface NotificationRuleSummary {
     /**
+     * @public
      * <p>The unique ID of the notification rule.</p>
      */
     Id?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule.</p>
      */
     Arn?: string;
@@ -513,10 +561,12 @@ export interface NotificationRuleSummary {
  */
 export interface ListNotificationRulesResult {
     /**
+     * @public
      * <p>An enumeration token that can be used in a request to return the next batch of the results.</p>
      */
     NextToken?: string;
     /**
+     * @public
      * <p>The list of notification rules for the Amazon Web Services account, by Amazon Resource Name (ARN) and ID. </p>
      */
     NotificationRules?: NotificationRuleSummary[];
@@ -526,6 +576,7 @@ export interface ListNotificationRulesResult {
  */
 export interface ListTagsForResourceRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) for the notification rule.</p>
      */
     Arn: string | undefined;
@@ -535,6 +586,7 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResult {
     /**
+     * @public
      * <p>The tags associated with the notification rule.</p>
      */
     Tags?: Record<string, string>;
@@ -562,10 +614,12 @@ export type ListTargetsFilterName = (typeof ListTargetsFilterName)[keyof typeof
  */
 export interface ListTargetsFilter {
     /**
+     * @public
      * <p>The name of the attribute you want to use to filter the returned targets.</p>
      */
     Name: ListTargetsFilterName | string | undefined;
     /**
+     * @public
      * <p>The value of the attribute you want to use to filter the returned targets. For example,
      *             if you specify <code>SNS</code> for the Target type, you could specify an Amazon
      *             Resource Name (ARN) for a topic as the value.</p>
@@ -577,6 +631,7 @@ export interface ListTargetsFilter {
  */
 export interface ListTargetsRequest {
     /**
+     * @public
      * <p>The filters to use to return information by service or resource type. Valid filters
      *             include target type, target address, and target status.</p>
      *          <note>
@@ -585,11 +640,13 @@ export interface ListTargetsRequest {
      */
     Filters?: ListTargetsFilter[];
     /**
+     * @public
      * <p>An enumeration token that, when provided in a request, returns the next batch of the
      *             results.</p>
      */
     NextToken?: string;
     /**
+     * @public
      * <p>A non-negative integer used to limit the number of returned results. The maximum number of
      *       results that can be returned is 100.</p>
      */
@@ -600,10 +657,12 @@ export interface ListTargetsRequest {
  */
 export interface ListTargetsResult {
     /**
+     * @public
      * <p>The list of notification rule targets. </p>
      */
     Targets?: TargetSummary[];
     /**
+     * @public
      * <p>An enumeration token that can be used in a request to return the next batch of
      *             results.</p>
      */
@@ -614,14 +673,17 @@ export interface ListTargetsResult {
  */
 export interface SubscribeRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.</p>
      */
     Arn: string | undefined;
     /**
+     * @public
      * <p>Information about the Chatbot topics or Chatbot clients associated with a  notification rule.</p>
      */
     Target: Target | undefined;
     /**
+     * @public
      * <p>An enumeration token that, when provided in a request, returns the next batch of the
      *             results.</p>
      */
@@ -632,6 +694,7 @@ export interface SubscribeRequest {
  */
 export interface SubscribeResult {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule for which you have created assocations.</p>
      */
     Arn?: string;
@@ -641,10 +704,12 @@ export interface SubscribeResult {
  */
 export interface TagResourceRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule to tag.</p>
      */
     Arn: string | undefined;
     /**
+     * @public
      * <p>The list of tags to associate with the resource. Tag key names cannot start with "<code>aws</code>".</p>
      */
     Tags: Record<string, string> | undefined;
@@ -654,6 +719,7 @@ export interface TagResourceRequest {
  */
 export interface TagResourceResult {
     /**
+     * @public
      * <p>The list of tags associated with the resource.</p>
      */
     Tags?: Record<string, string>;
@@ -663,10 +729,12 @@ export interface TagResourceResult {
  */
 export interface UnsubscribeRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule.</p>
      */
     Arn: string | undefined;
     /**
+     * @public
      * <p>The ARN of the Chatbot topic to unsubscribe from the notification rule.</p>
      */
     TargetAddress: string | undefined;
@@ -676,6 +744,7 @@ export interface UnsubscribeRequest {
  */
 export interface UnsubscribeResult {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the the notification rule from which you have removed a subscription.</p>
      */
     Arn: string | undefined;
@@ -685,11 +754,13 @@ export interface UnsubscribeResult {
  */
 export interface UntagResourceRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule from which to remove the
      *       tags.</p>
      */
     Arn: string | undefined;
     /**
+     * @public
      * <p>The key names of the tags to remove.</p>
      */
     TagKeys: string[] | undefined;
@@ -704,30 +775,36 @@ export interface UntagResourceResult {
  */
 export interface UpdateNotificationRuleRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule.</p>
      */
     Arn: string | undefined;
     /**
+     * @public
      * <p>The name of the notification rule.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>The status of the notification rule. Valid statuses include enabled (sending notifications) or
      *       disabled (not sending notifications).</p>
      */
     Status?: NotificationRuleStatus | string;
     /**
+     * @public
      * <p>A list of event types associated with this notification rule. For a complete list of event types and IDs, see
      *           <a href="https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api">Notification concepts</a>
      *        in the <i>Developer Tools Console User Guide</i>.</p>
      */
     EventTypeIds?: string[];
     /**
+     * @public
      * <p>The address and type of the targets to receive notifications from this notification
      *       rule.</p>
      */
     Targets?: Target[];
     /**
+     * @public
      * <p>The level of detail to include in the notifications for this resource. BASIC will include only the
      *             contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information
      *             provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.</p>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-codestar-notifications",
   "description": "AWS SDK for JavaScript Codestar Notifications Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.382.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.382.0",
+    "@aws-sdk/credential-provider-node": "3.382.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",