{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-codestar-notifications","description":"AWS CodeStar Notifications","version":"2019-10-15","base_url":"","endpoints":13,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api AWS CodeStar Notifications\n@version 2019-10-15\n@auth AWS SigV4\n@endpoints 13\n@toc createNotificationRule(1), deleteNotificationRule(1), deleteTarget(1), describeNotificationRule(1), listEventTypes(1), listNotificationRules(1), listTagsForResource(1), listTargets(1), subscribe(1), tagResource(1), unsubscribe(1), untagResource(1), updateNotificationRule(1)\n\n@group createNotificationRule\n@endpoint POST /createNotificationRule\n@desc Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as Chatbot topics or Chatbot clients configured for Slack) where you want to receive them.\n@required {Name: str, EventTypeIds: [str], Resource: str, Targets: [Target], DetailType: str}\n@optional {ClientRequestToken: str, Tags: map<str,str>, Status: str}\n@returns(200) {Arn: str?}\n\n@endgroup\n\n@group deleteNotificationRule\n@endpoint POST /deleteNotificationRule\n@desc Deletes a notification rule for a resource.\n@required {Arn: str}\n@returns(200) {Arn: str?}\n\n@endgroup\n\n@group deleteTarget\n@endpoint POST /deleteTarget\n@desc Deletes a specified target for notifications.\n@required {TargetAddress: str}\n@optional {ForceUnsubscribeAll: bool}\n\n@endgroup\n\n@group describeNotificationRule\n@endpoint POST /describeNotificationRule\n@desc Returns information about a specified notification rule.\n@required {Arn: str}\n@returns(200) {Arn: str, Name: str?, EventTypes: [EventTypeSummary]?, Resource: str?, Targets: [TargetSummary]?, DetailType: str?, CreatedBy: str?, Status: str?, CreatedTimestamp: str(timestamp)?, LastModifiedTimestamp: str(timestamp)?, Tags: map<str,str>?}\n\n@endgroup\n\n@group listEventTypes\n@endpoint POST /listEventTypes\n@desc Returns information about the event types available for configuring notifications.\n@optional {Filters: [ListEventTypesFilter], NextToken: str, MaxResults: int}\n@returns(200) {EventTypes: [EventTypeSummary]?, NextToken: str?}\n\n@endgroup\n\n@group listNotificationRules\n@endpoint POST /listNotificationRules\n@desc Returns a list of the notification rules for an Amazon Web Services account.\n@optional {Filters: [ListNotificationRulesFilter], NextToken: str, MaxResults: int}\n@returns(200) {NextToken: str?, NotificationRules: [NotificationRuleSummary]?}\n\n@endgroup\n\n@group listTagsForResource\n@endpoint POST /listTagsForResource\n@desc Returns a list of the tags associated with a notification rule.\n@required {Arn: str}\n@returns(200) {Tags: map<str,str>?}\n\n@endgroup\n\n@group listTargets\n@endpoint POST /listTargets\n@desc Returns a list of the notification rule targets for an Amazon Web Services account.\n@optional {Filters: [ListTargetsFilter], NextToken: str, MaxResults: int}\n@returns(200) {Targets: [TargetSummary]?, NextToken: str?}\n\n@endgroup\n\n@group subscribe\n@endpoint POST /subscribe\n@desc Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the associated target can receive notifications when the events described in the rule are triggered.\n@required {Arn: str, Target: Target}\n@optional {ClientRequestToken: str}\n@returns(200) {Arn: str?}\n\n@endgroup\n\n@group tagResource\n@endpoint POST /tagResource\n@desc Associates a set of provided tags with a notification rule.\n@required {Arn: str, Tags: map<str,str>}\n@returns(200) {Tags: map<str,str>?}\n\n@endgroup\n\n@group unsubscribe\n@endpoint POST /unsubscribe\n@desc Removes an association between a notification rule and an Chatbot topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.\n@required {Arn: str, TargetAddress: str}\n@returns(200) {Arn: str}\n\n@endgroup\n\n@group untagResource\n@endpoint POST /untagResource/{resourceArn}\n@desc Removes the association between one or more provided tags and a notification rule.\n@required {Arn: str, tagKeys: [str]}\n\n@endgroup\n\n@group updateNotificationRule\n@endpoint POST /updateNotificationRule\n@desc Updates a notification rule for a resource. You can change the events that trigger the notification rule, the status of the rule, and the targets that receive the notifications.  To add or remove tags for a notification rule, you must use TagResource and UntagResource.\n@required {Arn: str}\n@optional {Name: str, Status: str, EventTypeIds: [str], Targets: [Target], DetailType: str}\n\n@endgroup\n\n@end\n"}