@aws-sdk/client-codestar-notifications 3.533.0 → 3.540.0

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

@@ -1,9 +1,9 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { CodestarNotificationsServiceException as __BaseException } from "./CodestarNotificationsServiceException";
 /**
- * @public
  * <p>AWS CodeStar Notifications can't create the notification rule because you do not have sufficient
  *       permissions.</p>
+ * @public
  */
 export declare class AccessDeniedException extends __BaseException {
     readonly name: "AccessDeniedException";
@@ -15,9 +15,9 @@ export declare class AccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
 /**
- * @public
  * <p>AWS CodeStar Notifications can't complete the request because the resource is being modified by
  *       another process. Wait a few minutes and try again.</p>
+ * @public
  */
 export declare class ConcurrentModificationException extends __BaseException {
     readonly name: "ConcurrentModificationException";
@@ -29,8 +29,8 @@ export declare class ConcurrentModificationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
 }
 /**
- * @public
  * <p>Some or all of the configuration is incomplete, missing, or not valid.</p>
+ * @public
  */
 export declare class ConfigurationException extends __BaseException {
     readonly name: "ConfigurationException";
@@ -66,12 +66,11 @@ export declare const NotificationRuleStatus: {
  */
 export type NotificationRuleStatus = (typeof NotificationRuleStatus)[keyof typeof NotificationRuleStatus];
 /**
- * @public
  * <p>Information about the Chatbot topics or Chatbot clients associated with a  notification rule.</p>
+ * @public
  */
 export interface Target {
     /**
-     * @public
      * <p>The target type. Can be an Chatbot topic or Chatbot client.</p>
      *          <ul>
      *             <li>
@@ -81,11 +80,12 @@ export interface Target {
      *                <p>Chatbot clients are specified as <code>AWSChatbotSlack</code>.</p>
      *             </li>
      *          </ul>
+     * @public
      */
     TargetType?: string;
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.</p>
+     * @public
      */
     TargetAddress?: string;
 }
@@ -94,37 +94,36 @@ 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>
+     * @public
      */
     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>
+     * @public
      */
     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>
+     * @public
      */
     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>
+     * @public
      */
     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>
+     * @public
      */
     DetailType: DetailType | 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
@@ -133,17 +132,18 @@ export interface CreateNotificationRuleRequest {
      *             <p>The Amazon Web Services SDKs prepopulate client request tokens. If you are using an Amazon Web Services SDK, an
      *                 idempotency token is created for you.</p>
      *          </note>
+     * @public
      */
     ClientRequestToken?: string;
     /**
-     * @public
      * <p>A list of tags to apply to this notification rule. Key names cannot start with "<code>aws</code>". </p>
+     * @public
      */
     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>
+     * @public
      */
     Status?: NotificationRuleStatus;
 }
@@ -152,16 +152,16 @@ export interface CreateNotificationRuleRequest {
  */
 export interface CreateNotificationRuleResult {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule.</p>
+     * @public
      */
     Arn?: string;
 }
 /**
- * @public
  * <p>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.</p>
+ * @public
  */
 export declare class LimitExceededException extends __BaseException {
     readonly name: "LimitExceededException";
@@ -173,9 +173,9 @@ export declare class LimitExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
 /**
- * @public
  * <p>A resource with the same name or ID already exists. Notification rule names must be
  *             unique in your Amazon Web Services account.</p>
+ * @public
  */
 export declare class ResourceAlreadyExistsException extends __BaseException {
     readonly name: "ResourceAlreadyExistsException";
@@ -187,8 +187,8 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceAlreadyExistsException, __BaseException>);
 }
 /**
- * @public
  * <p>One or more parameter values are not valid.</p>
+ * @public
  */
 export declare class ValidationException extends __BaseException {
     readonly name: "ValidationException";
@@ -204,8 +204,8 @@ 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>
+     * @public
      */
     Arn: string | undefined;
 }
@@ -214,8 +214,8 @@ export interface DeleteNotificationRuleRequest {
  */
 export interface DeleteNotificationRuleResult {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the deleted notification rule.</p>
+     * @public
      */
     Arn?: string;
 }
@@ -224,15 +224,15 @@ export interface DeleteNotificationRuleResult {
  */
 export interface DeleteTargetRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client to delete.</p>
+     * @public
      */
     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>
+     * @public
      */
     ForceUnsubscribeAll?: boolean;
 }
@@ -246,36 +246,36 @@ export interface DeleteTargetResult {
  */
 export interface DescribeNotificationRuleRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule.</p>
+     * @public
      */
     Arn: string | undefined;
 }
 /**
- * @public
  * <p>Returns information about an event that has triggered a notification rule.</p>
+ * @public
  */
 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>
+     * @public
      */
     EventTypeId?: string;
     /**
-     * @public
      * <p>The name of the service for which the event applies.</p>
+     * @public
      */
     ServiceName?: string;
     /**
-     * @public
      * <p>The name of the event.</p>
+     * @public
      */
     EventTypeName?: string;
     /**
-     * @public
      * <p>The resource type of the event.</p>
+     * @public
      */
     ResourceType?: string;
 }
@@ -295,17 +295,16 @@ export declare const TargetStatus: {
  */
 export type TargetStatus = (typeof TargetStatus)[keyof typeof TargetStatus];
 /**
- * @public
  * <p>Information about the targets specified for a notification rule.</p>
+ * @public
  */
 export interface TargetSummary {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.</p>
+     * @public
      */
     TargetAddress?: string;
     /**
-     * @public
      * <p>The type of the target (for example, <code>SNS</code>).</p>
      *          <ul>
      *             <li>
@@ -315,11 +314,12 @@ export interface TargetSummary {
      *                <p>Chatbot clients are specified as <code>AWSChatbotSlack</code>.</p>
      *             </li>
      *          </ul>
+     * @public
      */
     TargetType?: string;
     /**
-     * @public
      * <p>The status of the target.</p>
+     * @public
      */
     TargetStatus?: TargetStatus;
 }
@@ -328,69 +328,69 @@ export interface TargetSummary {
  */
 export interface DescribeNotificationRuleResult {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule.</p>
+     * @public
      */
     Arn: string | undefined;
     /**
-     * @public
      * <p>The name of the notification rule.</p>
+     * @public
      */
     Name?: string;
     /**
-     * @public
      * <p>A list of the event types associated with the notification rule.</p>
+     * @public
      */
     EventTypes?: EventTypeSummary[];
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the resource associated with the notification
      *       rule.</p>
+     * @public
      */
     Resource?: string;
     /**
-     * @public
      * <p>A list of the Chatbot topics and Chatbot clients associated with the notification rule.</p>
+     * @public
      */
     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>
+     * @public
      */
     DetailType?: DetailType;
     /**
-     * @public
      * <p>The name or email alias of the person who created the notification rule.</p>
+     * @public
      */
     CreatedBy?: string;
     /**
-     * @public
      * <p>The status of the notification rule. Valid statuses are on (sending notifications) or off
      *       (not sending notifications).</p>
+     * @public
      */
     Status?: NotificationRuleStatus;
     /**
-     * @public
      * <p>The date and time the notification rule was created, in timestamp format.</p>
+     * @public
      */
     CreatedTimestamp?: Date;
     /**
-     * @public
      * <p>The date and time the notification rule was most recently updated, in timestamp
      *             format.</p>
+     * @public
      */
     LastModifiedTimestamp?: Date;
     /**
-     * @public
      * <p>The tags associated with the notification rule.</p>
+     * @public
      */
     Tags?: Record<string, string>;
 }
 /**
- * @public
  * <p>AWS CodeStar Notifications can't find a resource that matches the provided ARN. </p>
+ * @public
  */
 export declare class ResourceNotFoundException extends __BaseException {
     readonly name: "ResourceNotFoundException";
@@ -402,8 +402,8 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
- * @public
  * <p>The value for the enumeration token used in the request to return the next batch of the results is not valid. </p>
+ * @public
  */
 export declare class InvalidNextTokenException extends __BaseException {
     readonly name: "InvalidNextTokenException";
@@ -427,20 +427,20 @@ export declare const ListEventTypesFilterName: {
  */
 export type ListEventTypesFilterName = (typeof ListEventTypesFilterName)[keyof typeof ListEventTypesFilterName];
 /**
- * @public
  * <p>Information about a filter to apply to the list of returned event types. You can filter
  *       by resource type or service name.</p>
+ * @public
  */
 export interface ListEventTypesFilter {
     /**
-     * @public
      * <p>The system-generated name of the filter type you want to filter by.</p>
+     * @public
      */
     Name: ListEventTypesFilterName | 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>
+     * @public
      */
     Value: string | undefined;
 }
@@ -449,20 +449,20 @@ export interface ListEventTypesFilter {
  */
 export interface ListEventTypesRequest {
     /**
-     * @public
      * <p>The filters to use to return information by service or resource type.</p>
+     * @public
      */
     Filters?: ListEventTypesFilter[];
     /**
-     * @public
      * <p>An enumeration token that, when provided in a request, returns the next batch of the
      *             results.</p>
+     * @public
      */
     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>
+     * @public
      */
     MaxResults?: number;
 }
@@ -471,14 +471,14 @@ export interface ListEventTypesRequest {
  */
 export interface ListEventTypesResult {
     /**
-     * @public
      * <p>Information about each event, including service name, resource type, event ID, and event
      *       name.</p>
+     * @public
      */
     EventTypes?: EventTypeSummary[];
     /**
-     * @public
      * <p>An enumeration token that can be used in a request to return the next batch of the results.</p>
+     * @public
      */
     NextToken?: string;
 }
@@ -497,20 +497,20 @@ export declare const ListNotificationRulesFilterName: {
  */
 export type ListNotificationRulesFilterName = (typeof ListNotificationRulesFilterName)[keyof typeof ListNotificationRulesFilterName];
 /**
- * @public
  * <p>Information about a filter to apply to the list of returned notification rules. You can
  *       filter by event type, owner, resource, or target.</p>
+ * @public
  */
 export interface ListNotificationRulesFilter {
     /**
-     * @public
      * <p>The name of the attribute you want to use to filter the returned notification rules.</p>
+     * @public
      */
     Name: ListNotificationRulesFilterName | 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>
+     * @public
      */
     Value: string | undefined;
 }
@@ -519,40 +519,40 @@ 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>
      *             <p>A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.</p>
      *          </note>
+     * @public
      */
     Filters?: ListNotificationRulesFilter[];
     /**
-     * @public
      * <p>An enumeration token that, when provided in a request, returns the next batch of the
      *             results.</p>
+     * @public
      */
     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>
+     * @public
      */
     MaxResults?: number;
 }
 /**
- * @public
  * <p>Information about a specified notification rule.</p>
+ * @public
  */
 export interface NotificationRuleSummary {
     /**
-     * @public
      * <p>The unique ID of the notification rule.</p>
+     * @public
      */
     Id?: string;
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule.</p>
+     * @public
      */
     Arn?: string;
 }
@@ -561,13 +561,13 @@ 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>
+     * @public
      */
     NextToken?: string;
     /**
-     * @public
      * <p>The list of notification rules for the Amazon Web Services account, by Amazon Resource Name (ARN) and ID. </p>
+     * @public
      */
     NotificationRules?: NotificationRuleSummary[];
 }
@@ -576,8 +576,8 @@ export interface ListNotificationRulesResult {
  */
 export interface ListTagsForResourceRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) for the notification rule.</p>
+     * @public
      */
     Arn: string | undefined;
 }
@@ -586,8 +586,8 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResult {
     /**
-     * @public
      * <p>The tags associated with the notification rule.</p>
+     * @public
      */
     Tags?: Record<string, string>;
 }
@@ -605,24 +605,24 @@ export declare const ListTargetsFilterName: {
  */
 export type ListTargetsFilterName = (typeof ListTargetsFilterName)[keyof typeof ListTargetsFilterName];
 /**
- * @public
  * <p>Information about a filter to apply to the list of returned targets. You can filter by
  *             target type, address, or status. For example, to filter results to notification rules
  *             that have active Chatbot topics as targets, you could specify a ListTargetsFilter
  *             Name as <code>TargetType</code> and a Value of <code>SNS</code>, and a Name of <code>TARGET_STATUS</code> and a Value of
  *             <code>ACTIVE</code>.</p>
+ * @public
  */
 export interface ListTargetsFilter {
     /**
-     * @public
      * <p>The name of the attribute you want to use to filter the returned targets.</p>
+     * @public
      */
     Name: ListTargetsFilterName | 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>
+     * @public
      */
     Value: string | undefined;
 }
@@ -631,24 +631,24 @@ 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>
      *             <p>A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.</p>
      *          </note>
+     * @public
      */
     Filters?: ListTargetsFilter[];
     /**
-     * @public
      * <p>An enumeration token that, when provided in a request, returns the next batch of the
      *             results.</p>
+     * @public
      */
     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>
+     * @public
      */
     MaxResults?: number;
 }
@@ -657,14 +657,14 @@ export interface ListTargetsRequest {
  */
 export interface ListTargetsResult {
     /**
-     * @public
      * <p>The list of notification rule targets. </p>
+     * @public
      */
     Targets?: TargetSummary[];
     /**
-     * @public
      * <p>An enumeration token that can be used in a request to return the next batch of
      *             results.</p>
+     * @public
      */
     NextToken?: string;
 }
@@ -673,19 +673,19 @@ 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>
+     * @public
      */
     Arn: string | undefined;
     /**
-     * @public
      * <p>Information about the Chatbot topics or Chatbot clients associated with a  notification rule.</p>
+     * @public
      */
     Target: Target | undefined;
     /**
-     * @public
      * <p>An enumeration token that, when provided in a request, returns the next batch of the
      *             results.</p>
+     * @public
      */
     ClientRequestToken?: string;
 }
@@ -694,8 +694,8 @@ export interface SubscribeRequest {
  */
 export interface SubscribeResult {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule for which you have created assocations.</p>
+     * @public
      */
     Arn?: string;
 }
@@ -704,13 +704,13 @@ export interface SubscribeResult {
  */
 export interface TagResourceRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule to tag.</p>
+     * @public
      */
     Arn: string | undefined;
     /**
-     * @public
      * <p>The list of tags to associate with the resource. Tag key names cannot start with "<code>aws</code>".</p>
+     * @public
      */
     Tags: Record<string, string> | undefined;
 }
@@ -719,8 +719,8 @@ export interface TagResourceRequest {
  */
 export interface TagResourceResult {
     /**
-     * @public
      * <p>The list of tags associated with the resource.</p>
+     * @public
      */
     Tags?: Record<string, string>;
 }
@@ -729,13 +729,13 @@ export interface TagResourceResult {
  */
 export interface UnsubscribeRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule.</p>
+     * @public
      */
     Arn: string | undefined;
     /**
-     * @public
      * <p>The ARN of the Chatbot topic to unsubscribe from the notification rule.</p>
+     * @public
      */
     TargetAddress: string | undefined;
 }
@@ -744,8 +744,8 @@ 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>
+     * @public
      */
     Arn: string | undefined;
 }
@@ -754,14 +754,14 @@ export interface UnsubscribeResult {
  */
 export interface UntagResourceRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule from which to remove the
      *       tags.</p>
+     * @public
      */
     Arn: string | undefined;
     /**
-     * @public
      * <p>The key names of the tags to remove.</p>
+     * @public
      */
     TagKeys: string[] | undefined;
 }
@@ -775,39 +775,39 @@ export interface UntagResourceResult {
  */
 export interface UpdateNotificationRuleRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the notification rule.</p>
+     * @public
      */
     Arn: string | undefined;
     /**
-     * @public
      * <p>The name of the notification rule.</p>
+     * @public
      */
     Name?: string;
     /**
-     * @public
      * <p>The status of the notification rule. Valid statuses include enabled (sending notifications) or
      *       disabled (not sending notifications).</p>
+     * @public
      */
     Status?: NotificationRuleStatus;
     /**
-     * @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>
+     * @public
      */
     EventTypeIds?: string[];
     /**
-     * @public
      * <p>The address and type of the targets to receive notifications from this notification
      *       rule.</p>
+     * @public
      */
     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>
+     * @public
      */
     DetailType?: DetailType;
 }