{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.codestarnotifications#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.codestarnotifications#Message" } }, "traits": { "smithy.api#documentation": "

\n CodeStar Notifications can't create the notification rule because you do not have sufficient\n permissions.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.codestarnotifications#ClientRequestToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\w:/-]+$" } }, "com.amazonaws.codestarnotifications#CodeStarNotifications_20191015": { "type": "service", "version": "2019-10-15", "operations": [ { "target": "com.amazonaws.codestarnotifications#CreateNotificationRule" }, { "target": "com.amazonaws.codestarnotifications#DeleteNotificationRule" }, { "target": "com.amazonaws.codestarnotifications#DeleteTarget" }, { "target": "com.amazonaws.codestarnotifications#DescribeNotificationRule" }, { "target": "com.amazonaws.codestarnotifications#ListEventTypes" }, { "target": "com.amazonaws.codestarnotifications#ListNotificationRules" }, { "target": "com.amazonaws.codestarnotifications#ListTagsForResource" }, { "target": "com.amazonaws.codestarnotifications#ListTargets" }, { "target": "com.amazonaws.codestarnotifications#Subscribe" }, { "target": "com.amazonaws.codestarnotifications#TagResource" }, { "target": "com.amazonaws.codestarnotifications#Unsubscribe" }, { "target": "com.amazonaws.codestarnotifications#UntagResource" }, { "target": "com.amazonaws.codestarnotifications#UpdateNotificationRule" } ], "traits": { "aws.api#service": { "sdkId": "codestar notifications", "arnNamespace": "codestar-notifications", "cloudFormationName": "CodeStarNotifications", "cloudTrailEventSource": "codestarnotifications.amazonaws.com", "endpointPrefix": "codestar-notifications" }, "aws.auth#sigv4": { "name": "codestar-notifications" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "

This CodeStar Notifications API Reference provides descriptions and usage examples of the\n operations and data types for the CodeStar Notifications API. You can use the CodeStar Notifications API\n to work with the following objects:

\n

Notification rules, by calling the following:

\n \n

Targets, by calling the following:

\n \n

Events, by calling the following:

\n \n

Tags, by calling the following:

\n \n

For information about how to use CodeStar Notifications, see the \n Amazon Web Services Developer Tools Console User Guide.\n

", "smithy.api#title": "AWS CodeStar Notifications", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://codestar-notifications-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://codestar-notifications-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://codestar-notifications.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://codestar-notifications.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://codestar-notifications-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://codestar-notifications-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://codestar-notifications.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://codestar-notifications.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://codestar-notifications-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://codestar-notifications-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://codestar-notifications.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://codestar-notifications.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://codestar-notifications-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://codestar-notifications-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://codestar-notifications.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://codestar-notifications.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://codestar-notifications-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://codestar-notifications-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://codestar-notifications.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://codestar-notifications.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://codestar-notifications-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://codestar-notifications.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://codestar-notifications-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://codestar-notifications.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.codestarnotifications#ConcurrentModificationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.codestarnotifications#Message" } }, "traits": { "smithy.api#documentation": "

\n CodeStar Notifications can't complete the request because the resource is being modified by\n another process. Wait a few minutes and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.codestarnotifications#ConfigurationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.codestarnotifications#Message" } }, "traits": { "smithy.api#documentation": "

Some or all of the configuration is incomplete, missing, or not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.codestarnotifications#CreateNotificationRule": { "type": "operation", "input": { "target": "com.amazonaws.codestarnotifications#CreateNotificationRuleRequest" }, "output": { "target": "com.amazonaws.codestarnotifications#CreateNotificationRuleResult" }, "errors": [ { "target": "com.amazonaws.codestarnotifications#AccessDeniedException" }, { "target": "com.amazonaws.codestarnotifications#ConcurrentModificationException" }, { "target": "com.amazonaws.codestarnotifications#ConfigurationException" }, { "target": "com.amazonaws.codestarnotifications#LimitExceededException" }, { "target": "com.amazonaws.codestarnotifications#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.codestarnotifications#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a notification rule for a resource. The rule specifies the events you want\n notifications about and the targets (such as Amazon Q Developer in chat applications topics or Amazon Q Developer in chat applications clients configured for Slack) where you want to receive\n them.

", "smithy.api#http": { "method": "POST", "uri": "/createNotificationRule", "code": 200 } } }, "com.amazonaws.codestarnotifications#CreateNotificationRuleRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.codestarnotifications#NotificationRuleName", "traits": { "smithy.api#documentation": "

The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.

", "smithy.api#required": {} } }, "EventTypeIds": { "target": "com.amazonaws.codestarnotifications#EventTypeIds", "traits": { "smithy.api#documentation": "

A list of event types associated with this notification rule. For a list of allowed\n events, see EventTypeSummary.

", "smithy.api#required": {} } }, "Resource": { "target": "com.amazonaws.codestarnotifications#NotificationRuleResource", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in CodePipeline,\n repositories in CodeCommit, and build projects in CodeBuild.

", "smithy.api#required": {} } }, "Targets": { "target": "com.amazonaws.codestarnotifications#Targets", "traits": { "smithy.api#documentation": "

A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Amazon Q Developer in chat applications clients to associate with the\n notification rule.

", "smithy.api#required": {} } }, "DetailType": { "target": "com.amazonaws.codestarnotifications#DetailType", "traits": { "smithy.api#documentation": "

The level of detail to include in the notifications for this resource. BASIC will include only the \n contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information\n provided by CodeStar Notifications and/or the service for the resource for which the notification is created.

", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.codestarnotifications#ClientRequestToken", "traits": { "smithy.api#documentation": "

A unique, client-generated idempotency token that, when provided in a request, ensures\n the request cannot be repeated with a changed parameter. If a request with the same\n parameters is received and a token is included, the request returns information about\n the initial request that used that token.

\n \n

The Amazon Web Services SDKs prepopulate client request tokens. If you are using an Amazon Web Services SDK, an\n idempotency token is created for you.

\n
", "smithy.api#idempotencyToken": {} } }, "Tags": { "target": "com.amazonaws.codestarnotifications#Tags", "traits": { "smithy.api#documentation": "

A list of tags to apply to this notification rule. Key names cannot start with \"aws\".

" } }, "Status": { "target": "com.amazonaws.codestarnotifications#NotificationRuleStatus", "traits": { "smithy.api#documentation": "

The status of the notification rule. The default value is ENABLED. If the status is\n set to DISABLED, notifications aren't sent for the notification rule.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.codestarnotifications#CreateNotificationRuleResult": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.codestarnotifications#CreatedTimestamp": { "type": "timestamp" }, "com.amazonaws.codestarnotifications#DeleteNotificationRule": { "type": "operation", "input": { "target": "com.amazonaws.codestarnotifications#DeleteNotificationRuleRequest" }, "output": { "target": "com.amazonaws.codestarnotifications#DeleteNotificationRuleResult" }, "errors": [ { "target": "com.amazonaws.codestarnotifications#ConcurrentModificationException" }, { "target": "com.amazonaws.codestarnotifications#LimitExceededException" }, { "target": "com.amazonaws.codestarnotifications#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a notification rule for a resource.

", "smithy.api#http": { "method": "POST", "uri": "/deleteNotificationRule", "code": 200 } } }, "com.amazonaws.codestarnotifications#DeleteNotificationRuleRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule you want to delete.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.codestarnotifications#DeleteNotificationRuleResult": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted notification rule.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.codestarnotifications#DeleteTarget": { "type": "operation", "input": { "target": "com.amazonaws.codestarnotifications#DeleteTargetRequest" }, "output": { "target": "com.amazonaws.codestarnotifications#DeleteTargetResult" }, "errors": [ { "target": "com.amazonaws.codestarnotifications#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a specified target for notifications.

", "smithy.api#http": { "method": "POST", "uri": "/deleteTarget", "code": 200 } } }, "com.amazonaws.codestarnotifications#DeleteTargetRequest": { "type": "structure", "members": { "TargetAddress": { "target": "com.amazonaws.codestarnotifications#TargetAddress", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client to delete.

", "smithy.api#required": {} } }, "ForceUnsubscribeAll": { "target": "com.amazonaws.codestarnotifications#ForceUnsubscribeAll", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

A Boolean value that can be used to delete all associations with this Amazon Q Developer in chat applications topic. The\n default value is FALSE. If set to TRUE, all associations between that target and every\n notification rule in your Amazon Web Services account are deleted.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.codestarnotifications#DeleteTargetResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.codestarnotifications#DescribeNotificationRule": { "type": "operation", "input": { "target": "com.amazonaws.codestarnotifications#DescribeNotificationRuleRequest" }, "output": { "target": "com.amazonaws.codestarnotifications#DescribeNotificationRuleResult" }, "errors": [ { "target": "com.amazonaws.codestarnotifications#ResourceNotFoundException" }, { "target": "com.amazonaws.codestarnotifications#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns information about a specified notification rule.

", "smithy.api#http": { "method": "POST", "uri": "/describeNotificationRule", "code": 200 } } }, "com.amazonaws.codestarnotifications#DescribeNotificationRuleRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.codestarnotifications#DescribeNotificationRuleResult": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.codestarnotifications#NotificationRuleName", "traits": { "smithy.api#documentation": "

The name of the notification rule.

" } }, "EventTypes": { "target": "com.amazonaws.codestarnotifications#EventTypeBatch", "traits": { "smithy.api#documentation": "

A list of the event types associated with the notification rule.

" } }, "Resource": { "target": "com.amazonaws.codestarnotifications#NotificationRuleResource", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource associated with the notification\n rule.

" } }, "Targets": { "target": "com.amazonaws.codestarnotifications#TargetsBatch", "traits": { "smithy.api#documentation": "

A list of the Amazon Q Developer in chat applications topics and Amazon Q Developer in chat applications clients associated with the notification rule.

" } }, "DetailType": { "target": "com.amazonaws.codestarnotifications#DetailType", "traits": { "smithy.api#documentation": "

The level of detail included in the notifications for this resource. BASIC will include only the \n contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information\n provided by CodeStar Notifications and/or the service for the resource for which the notification is created.

" } }, "CreatedBy": { "target": "com.amazonaws.codestarnotifications#NotificationRuleCreatedBy", "traits": { "smithy.api#documentation": "

The name or email alias of the person who created the notification rule.

" } }, "Status": { "target": "com.amazonaws.codestarnotifications#NotificationRuleStatus", "traits": { "smithy.api#documentation": "

The status of the notification rule. Valid statuses are on (sending notifications) or off\n (not sending notifications).

" } }, "CreatedTimestamp": { "target": "com.amazonaws.codestarnotifications#CreatedTimestamp", "traits": { "smithy.api#documentation": "

The date and time the notification rule was created, in timestamp format.

" } }, "LastModifiedTimestamp": { "target": "com.amazonaws.codestarnotifications#LastModifiedTimestamp", "traits": { "smithy.api#documentation": "

The date and time the notification rule was most recently updated, in timestamp\n format.

" } }, "Tags": { "target": "com.amazonaws.codestarnotifications#Tags", "traits": { "smithy.api#documentation": "

The tags associated with the notification rule.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.codestarnotifications#DetailType": { "type": "enum", "members": { "BASIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BASIC" } }, "FULL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FULL" } } } }, "com.amazonaws.codestarnotifications#EventTypeBatch": { "type": "list", "member": { "target": "com.amazonaws.codestarnotifications#EventTypeSummary" } }, "com.amazonaws.codestarnotifications#EventTypeId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.codestarnotifications#EventTypeIds": { "type": "list", "member": { "target": "com.amazonaws.codestarnotifications#EventTypeId" } }, "com.amazonaws.codestarnotifications#EventTypeName": { "type": "string" }, "com.amazonaws.codestarnotifications#EventTypeSummary": { "type": "structure", "members": { "EventTypeId": { "target": "com.amazonaws.codestarnotifications#EventTypeId", "traits": { "smithy.api#documentation": "

The system-generated ID of the event. For a complete list of event types and IDs, see \n Notification concepts\n in the Developer Tools Console User Guide.

" } }, "ServiceName": { "target": "com.amazonaws.codestarnotifications#ServiceName", "traits": { "smithy.api#documentation": "

The name of the service for which the event applies.

" } }, "EventTypeName": { "target": "com.amazonaws.codestarnotifications#EventTypeName", "traits": { "smithy.api#documentation": "

The name of the event.

" } }, "ResourceType": { "target": "com.amazonaws.codestarnotifications#ResourceType", "traits": { "smithy.api#documentation": "

The resource type of the event.

" } } }, "traits": { "smithy.api#documentation": "

Returns information about an event that has triggered a notification rule.

" } }, "com.amazonaws.codestarnotifications#ForceUnsubscribeAll": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.codestarnotifications#InvalidNextTokenException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.codestarnotifications#Message" } }, "traits": { "smithy.api#documentation": "

The value for the enumeration token used in the request to return the next batch of the results is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.codestarnotifications#LastModifiedTimestamp": { "type": "timestamp" }, "com.amazonaws.codestarnotifications#LimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.codestarnotifications#Message" } }, "traits": { "smithy.api#documentation": "

One of the CodeStar Notifications limits has been exceeded. Limits apply to\n accounts, notification rules, notifications, resources, and targets. For more\n information, see Limits.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.codestarnotifications#ListEventTypes": { "type": "operation", "input": { "target": "com.amazonaws.codestarnotifications#ListEventTypesRequest" }, "output": { "target": "com.amazonaws.codestarnotifications#ListEventTypesResult" }, "errors": [ { "target": "com.amazonaws.codestarnotifications#InvalidNextTokenException" }, { "target": "com.amazonaws.codestarnotifications#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns information about the event types available for configuring notifications.

", "smithy.api#http": { "method": "POST", "uri": "/listEventTypes", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "EventTypes", "pageSize": "MaxResults" } } }, "com.amazonaws.codestarnotifications#ListEventTypesFilter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.codestarnotifications#ListEventTypesFilterName", "traits": { "smithy.api#documentation": "

The system-generated name of the filter type you want to filter by.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.codestarnotifications#ListEventTypesFilterValue", "traits": { "smithy.api#documentation": "

The name of the resource type (for example, pipeline) or service name (for example,\n CodePipeline) that you want to filter by.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Information about a filter to apply to the list of returned event types. You can filter\n by resource type or service name.

" } }, "com.amazonaws.codestarnotifications#ListEventTypesFilterName": { "type": "enum", "members": { "RESOURCE_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOURCE_TYPE" } }, "SERVICE_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SERVICE_NAME" } } } }, "com.amazonaws.codestarnotifications#ListEventTypesFilterValue": { "type": "string" }, "com.amazonaws.codestarnotifications#ListEventTypesFilters": { "type": "list", "member": { "target": "com.amazonaws.codestarnotifications#ListEventTypesFilter" } }, "com.amazonaws.codestarnotifications#ListEventTypesRequest": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.codestarnotifications#ListEventTypesFilters", "traits": { "smithy.api#documentation": "

The filters to use to return information by service or resource type.

" } }, "NextToken": { "target": "com.amazonaws.codestarnotifications#NextToken", "traits": { "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" } }, "MaxResults": { "target": "com.amazonaws.codestarnotifications#MaxResults", "traits": { "smithy.api#documentation": "

A non-negative integer used to limit the number of returned results. The default number is 50. The maximum number of\n results that can be returned is 100.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.codestarnotifications#ListEventTypesResult": { "type": "structure", "members": { "EventTypes": { "target": "com.amazonaws.codestarnotifications#EventTypeBatch", "traits": { "smithy.api#documentation": "

Information about each event, including service name, resource type, event ID, and event\n name.

" } }, "NextToken": { "target": "com.amazonaws.codestarnotifications#NextToken", "traits": { "smithy.api#documentation": "

An enumeration token that can be used in a request to return the next batch of the results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.codestarnotifications#ListNotificationRules": { "type": "operation", "input": { "target": "com.amazonaws.codestarnotifications#ListNotificationRulesRequest" }, "output": { "target": "com.amazonaws.codestarnotifications#ListNotificationRulesResult" }, "errors": [ { "target": "com.amazonaws.codestarnotifications#InvalidNextTokenException" }, { "target": "com.amazonaws.codestarnotifications#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns a list of the notification rules for an Amazon Web Services account.

", "smithy.api#http": { "method": "POST", "uri": "/listNotificationRules", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "NotificationRules", "pageSize": "MaxResults" } } }, "com.amazonaws.codestarnotifications#ListNotificationRulesFilter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.codestarnotifications#ListNotificationRulesFilterName", "traits": { "smithy.api#documentation": "

The name of the attribute you want to use to filter the returned notification rules.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.codestarnotifications#ListNotificationRulesFilterValue", "traits": { "smithy.api#documentation": "

The value of the attribute you want to use to filter the returned notification rules. For example, if you specify filtering by RESOURCE \n in Name, you might specify the ARN of a pipeline in CodePipeline for the value.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Information about a filter to apply to the list of returned notification rules. You can\n filter by event type, owner, resource, or target.

" } }, "com.amazonaws.codestarnotifications#ListNotificationRulesFilterName": { "type": "enum", "members": { "EVENT_TYPE_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EVENT_TYPE_ID" } }, "CREATED_BY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED_BY" } }, "RESOURCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOURCE" } }, "TARGET_ADDRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TARGET_ADDRESS" } } } }, "com.amazonaws.codestarnotifications#ListNotificationRulesFilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.codestarnotifications#ListNotificationRulesFilters": { "type": "list", "member": { "target": "com.amazonaws.codestarnotifications#ListNotificationRulesFilter" } }, "com.amazonaws.codestarnotifications#ListNotificationRulesRequest": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.codestarnotifications#ListNotificationRulesFilters", "traits": { "smithy.api#documentation": "

The filters to use to return information by service or resource type. For valid values,\n see ListNotificationRulesFilter.

\n \n

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.

\n
" } }, "NextToken": { "target": "com.amazonaws.codestarnotifications#NextToken", "traits": { "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" } }, "MaxResults": { "target": "com.amazonaws.codestarnotifications#MaxResults", "traits": { "smithy.api#documentation": "

A non-negative integer used to limit the number of returned results. The maximum number of\n results that can be returned is 100.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.codestarnotifications#ListNotificationRulesResult": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.codestarnotifications#NextToken", "traits": { "smithy.api#documentation": "

An enumeration token that can be used in a request to return the next batch of the results.

" } }, "NotificationRules": { "target": "com.amazonaws.codestarnotifications#NotificationRuleBatch", "traits": { "smithy.api#documentation": "

The list of notification rules for the Amazon Web Services account, by Amazon Resource Name (ARN) and ID.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.codestarnotifications#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.codestarnotifications#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.codestarnotifications#ListTagsForResourceResult" }, "errors": [ { "target": "com.amazonaws.codestarnotifications#ResourceNotFoundException" }, { "target": "com.amazonaws.codestarnotifications#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/listTagsForResource", "code": 200 } } }, "com.amazonaws.codestarnotifications#ListTagsForResourceRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the notification rule.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.codestarnotifications#ListTagsForResourceResult": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.codestarnotifications#Tags", "traits": { "smithy.api#documentation": "

The tags associated with the notification rule.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.codestarnotifications#ListTargets": { "type": "operation", "input": { "target": "com.amazonaws.codestarnotifications#ListTargetsRequest" }, "output": { "target": "com.amazonaws.codestarnotifications#ListTargetsResult" }, "errors": [ { "target": "com.amazonaws.codestarnotifications#InvalidNextTokenException" }, { "target": "com.amazonaws.codestarnotifications#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns a list of the notification rule targets for an Amazon Web Services account.

", "smithy.api#http": { "method": "POST", "uri": "/listTargets", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Targets", "pageSize": "MaxResults" } } }, "com.amazonaws.codestarnotifications#ListTargetsFilter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.codestarnotifications#ListTargetsFilterName", "traits": { "smithy.api#documentation": "

The name of the attribute you want to use to filter the returned targets.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.codestarnotifications#ListTargetsFilterValue", "traits": { "smithy.api#documentation": "

The value of the attribute you want to use to filter the returned targets. For example,\n if you specify SNS for the Target type, you could specify an Amazon\n Resource Name (ARN) for a topic as the value.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Information about a filter to apply to the list of returned targets. You can filter by\n target type, address, or status. For example, to filter results to notification rules\n that have active Amazon Q Developer in chat applications topics as targets, you could specify a ListTargetsFilter\n Name as TargetType and a Value of SNS, and a Name of TARGET_STATUS and a Value of\n ACTIVE.

" } }, "com.amazonaws.codestarnotifications#ListTargetsFilterName": { "type": "enum", "members": { "TARGET_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TARGET_TYPE" } }, "TARGET_ADDRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TARGET_ADDRESS" } }, "TARGET_STATUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TARGET_STATUS" } } } }, "com.amazonaws.codestarnotifications#ListTargetsFilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.codestarnotifications#ListTargetsFilters": { "type": "list", "member": { "target": "com.amazonaws.codestarnotifications#ListTargetsFilter" } }, "com.amazonaws.codestarnotifications#ListTargetsRequest": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.codestarnotifications#ListTargetsFilters", "traits": { "smithy.api#documentation": "

The filters to use to return information by service or resource type. Valid filters\n include target type, target address, and target status.

\n \n

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.

\n
" } }, "NextToken": { "target": "com.amazonaws.codestarnotifications#NextToken", "traits": { "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" } }, "MaxResults": { "target": "com.amazonaws.codestarnotifications#MaxResults", "traits": { "smithy.api#documentation": "

A non-negative integer used to limit the number of returned results. The maximum number of\n results that can be returned is 100.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.codestarnotifications#ListTargetsResult": { "type": "structure", "members": { "Targets": { "target": "com.amazonaws.codestarnotifications#TargetsBatch", "traits": { "smithy.api#documentation": "

The list of notification rule targets.

" } }, "NextToken": { "target": "com.amazonaws.codestarnotifications#NextToken", "traits": { "smithy.api#documentation": "

An enumeration token that can be used in a request to return the next batch of\n results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.codestarnotifications#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.codestarnotifications#Message": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.codestarnotifications#NextToken": { "type": "string", "traits": { "smithy.api#pattern": "^[\\w/+=]+$" } }, "com.amazonaws.codestarnotifications#NotificationRuleArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:\\s]*:codestar-notifications:[^:\\s]+:\\d{12}:notificationrule\\/(.*\\S)?$" } }, "com.amazonaws.codestarnotifications#NotificationRuleBatch": { "type": "list", "member": { "target": "com.amazonaws.codestarnotifications#NotificationRuleSummary" } }, "com.amazonaws.codestarnotifications#NotificationRuleCreatedBy": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.codestarnotifications#NotificationRuleId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 40 } } }, "com.amazonaws.codestarnotifications#NotificationRuleName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9\\-_ ]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.codestarnotifications#NotificationRuleResource": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[^:\\s]*:[^:\\s]*:[^:\\s]*:[0-9]{12}:[^\\s]+$" } }, "com.amazonaws.codestarnotifications#NotificationRuleStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.codestarnotifications#NotificationRuleSummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.codestarnotifications#NotificationRuleId", "traits": { "smithy.api#documentation": "

The unique ID of the notification rule.

" } }, "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule.

" } } }, "traits": { "smithy.api#documentation": "

Information about a specified notification rule.

" } }, "com.amazonaws.codestarnotifications#ResourceAlreadyExistsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.codestarnotifications#Message" } }, "traits": { "smithy.api#documentation": "

A resource with the same name or ID already exists. Notification rule names must be\n unique in your Amazon Web Services account.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.codestarnotifications#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.codestarnotifications#Message" } }, "traits": { "smithy.api#documentation": "

\n CodeStar Notifications can't find a resource that matches the provided ARN.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.codestarnotifications#ResourceType": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "^([a-zA-Z0-9-])+$" } }, "com.amazonaws.codestarnotifications#ServiceName": { "type": "string" }, "com.amazonaws.codestarnotifications#Subscribe": { "type": "operation", "input": { "target": "com.amazonaws.codestarnotifications#SubscribeRequest" }, "output": { "target": "com.amazonaws.codestarnotifications#SubscribeResult" }, "errors": [ { "target": "com.amazonaws.codestarnotifications#ConfigurationException" }, { "target": "com.amazonaws.codestarnotifications#ResourceNotFoundException" }, { "target": "com.amazonaws.codestarnotifications#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates an association between a notification rule and an Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client so that the\n associated target can receive notifications when the events described in the rule are\n triggered.

", "smithy.api#http": { "method": "POST", "uri": "/subscribe", "code": 200 } } }, "com.amazonaws.codestarnotifications#SubscribeRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.

", "smithy.api#required": {} } }, "Target": { "target": "com.amazonaws.codestarnotifications#Target", "traits": { "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.codestarnotifications#ClientRequestToken", "traits": { "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.codestarnotifications#SubscribeResult": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule for which you have created assocations.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.codestarnotifications#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.codestarnotifications#TagKeys": { "type": "list", "member": { "target": "com.amazonaws.codestarnotifications#TagKey" } }, "com.amazonaws.codestarnotifications#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.codestarnotifications#TagResourceRequest" }, "output": { "target": "com.amazonaws.codestarnotifications#TagResourceResult" }, "errors": [ { "target": "com.amazonaws.codestarnotifications#ConcurrentModificationException" }, { "target": "com.amazonaws.codestarnotifications#LimitExceededException" }, { "target": "com.amazonaws.codestarnotifications#ResourceNotFoundException" }, { "target": "com.amazonaws.codestarnotifications#ValidationException" } ], "traits": { "smithy.api#documentation": "

Associates a set of provided tags with a notification rule.

", "smithy.api#http": { "method": "POST", "uri": "/tagResource", "code": 200 } } }, "com.amazonaws.codestarnotifications#TagResourceRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule to tag.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.codestarnotifications#Tags", "traits": { "smithy.api#documentation": "

The list of tags to associate with the resource. Tag key names cannot start with \"aws\".

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.codestarnotifications#TagResourceResult": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.codestarnotifications#Tags", "traits": { "smithy.api#documentation": "

The list of tags associated with the resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.codestarnotifications#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.codestarnotifications#Tags": { "type": "map", "key": { "target": "com.amazonaws.codestarnotifications#TagKey" }, "value": { "target": "com.amazonaws.codestarnotifications#TagValue" } }, "com.amazonaws.codestarnotifications#Target": { "type": "structure", "members": { "TargetType": { "target": "com.amazonaws.codestarnotifications#TargetType", "traits": { "smithy.api#documentation": "

The target type. Can be an Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client.

\n " } }, "TargetAddress": { "target": "com.amazonaws.codestarnotifications#TargetAddress", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client.

" } } }, "traits": { "smithy.api#documentation": "

Information about the Amazon Q Developer in chat applications topics or Amazon Q Developer in chat applications clients associated with a notification rule.

" } }, "com.amazonaws.codestarnotifications#TargetAddress": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 320 }, "smithy.api#sensitive": {} } }, "com.amazonaws.codestarnotifications#TargetStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "UNREACHABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNREACHABLE" } }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } }, "DEACTIVATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEACTIVATED" } } } }, "com.amazonaws.codestarnotifications#TargetSummary": { "type": "structure", "members": { "TargetAddress": { "target": "com.amazonaws.codestarnotifications#TargetAddress", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client.

" } }, "TargetType": { "target": "com.amazonaws.codestarnotifications#TargetType", "traits": { "smithy.api#documentation": "

The type of the target (for example, SNS).

\n " } }, "TargetStatus": { "target": "com.amazonaws.codestarnotifications#TargetStatus", "traits": { "smithy.api#documentation": "

The status of the target.

" } } }, "traits": { "smithy.api#documentation": "

Information about the targets specified for a notification rule.

" } }, "com.amazonaws.codestarnotifications#TargetType": { "type": "string", "traits": { "smithy.api#pattern": "^[A-Za-z]+$" } }, "com.amazonaws.codestarnotifications#Targets": { "type": "list", "member": { "target": "com.amazonaws.codestarnotifications#Target" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.codestarnotifications#TargetsBatch": { "type": "list", "member": { "target": "com.amazonaws.codestarnotifications#TargetSummary" } }, "com.amazonaws.codestarnotifications#Unsubscribe": { "type": "operation", "input": { "target": "com.amazonaws.codestarnotifications#UnsubscribeRequest" }, "output": { "target": "com.amazonaws.codestarnotifications#UnsubscribeResult" }, "errors": [ { "target": "com.amazonaws.codestarnotifications#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes an association between a notification rule and an Amazon Q Developer in chat applications topic so that\n subscribers to that topic stop receiving notifications when the events described in the\n rule are triggered.

", "smithy.api#http": { "method": "POST", "uri": "/unsubscribe", "code": 200 } } }, "com.amazonaws.codestarnotifications#UnsubscribeRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule.

", "smithy.api#required": {} } }, "TargetAddress": { "target": "com.amazonaws.codestarnotifications#TargetAddress", "traits": { "smithy.api#documentation": "

The ARN of the Amazon Q Developer in chat applications topic to unsubscribe from the notification rule.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.codestarnotifications#UnsubscribeResult": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the the notification rule from which you have removed a subscription.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.codestarnotifications#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.codestarnotifications#UntagResourceRequest" }, "output": { "target": "com.amazonaws.codestarnotifications#UntagResourceResult" }, "errors": [ { "target": "com.amazonaws.codestarnotifications#ConcurrentModificationException" }, { "target": "com.amazonaws.codestarnotifications#LimitExceededException" }, { "target": "com.amazonaws.codestarnotifications#ResourceNotFoundException" }, { "target": "com.amazonaws.codestarnotifications#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/untagResource/{Arn}", "code": 200 } } }, "com.amazonaws.codestarnotifications#UntagResourceRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule from which to remove the\n tags.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.codestarnotifications#TagKeys", "traits": { "smithy.api#documentation": "

The key names of the tags to remove.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.codestarnotifications#UntagResourceResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.codestarnotifications#UpdateNotificationRule": { "type": "operation", "input": { "target": "com.amazonaws.codestarnotifications#UpdateNotificationRuleRequest" }, "output": { "target": "com.amazonaws.codestarnotifications#UpdateNotificationRuleResult" }, "errors": [ { "target": "com.amazonaws.codestarnotifications#ConfigurationException" }, { "target": "com.amazonaws.codestarnotifications#ResourceNotFoundException" }, { "target": "com.amazonaws.codestarnotifications#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates a notification rule for a resource. You can change the events that trigger the\n notification rule, the status of the rule, and the targets that receive the\n notifications.

\n \n

To add or remove tags for a notification rule, you must use TagResource and UntagResource.

\n
", "smithy.api#http": { "method": "POST", "uri": "/updateNotificationRule", "code": 200 } } }, "com.amazonaws.codestarnotifications#UpdateNotificationRuleRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.codestarnotifications#NotificationRuleName", "traits": { "smithy.api#documentation": "

The name of the notification rule.

" } }, "Status": { "target": "com.amazonaws.codestarnotifications#NotificationRuleStatus", "traits": { "smithy.api#documentation": "

The status of the notification rule. Valid statuses include enabled (sending notifications) or\n disabled (not sending notifications).

" } }, "EventTypeIds": { "target": "com.amazonaws.codestarnotifications#EventTypeIds", "traits": { "smithy.api#documentation": "

A list of event types associated with this notification rule. For a complete list of event types and IDs, see \n Notification concepts\n in the Developer Tools Console User Guide.

" } }, "Targets": { "target": "com.amazonaws.codestarnotifications#Targets", "traits": { "smithy.api#documentation": "

The address and type of the targets to receive notifications from this notification\n rule.

" } }, "DetailType": { "target": "com.amazonaws.codestarnotifications#DetailType", "traits": { "smithy.api#documentation": "

The level of detail to include in the notifications for this resource. BASIC will include only the \n contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information\n provided by CodeStar Notifications and/or the service for the resource for which the notification is created.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.codestarnotifications#UpdateNotificationRuleResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.codestarnotifications#ValidationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.codestarnotifications#Message" } }, "traits": { "smithy.api#documentation": "

One or more parameter values are not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } } } }