@datafire/amazonaws_codestar_notifications

Client library for AWS CodeStar Notifications

Installation and Usage

npm install --save @datafire/amazonaws_codestar_notifications

let amazonaws_codestar_notifications = require('@datafire/amazonaws_codestar_notifications').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

CreateNotificationRule

amazonaws_codestar_notifications.CreateNotificationRule({
  "Name": "",
  "EventTypeIds": [],
  "Resource": "",
  "Targets": [],
  "DetailType": ""
}, context)

Input

• input object
  • ClientRequestToken string: 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 the initial request that used that token. The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an idempotency token is created for you.
  • DetailType required string (values: BASIC, FULL): 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 AWS 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.
  • EventTypeIds required array: A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.
    • items EventTypeId
  • Name required string: The name for the notification rule. Notifictaion rule names must be unique in your AWS account.
  • Resource required string: The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in AWS CodePipeline, repositories in AWS CodeCommit, and build projects in AWS CodeBuild.
  • Status string (values: ENABLED, DISABLED): The status of the notification rule. The default value is ENABLED. If the status is set to DISABLED, notifications aren't sent for the notification rule.
  • Tags object: A list of tags to apply to this notification rule. Key names cannot start with "aws".
  • Targets required array: A list of Amazon Resource Names (ARNs) of SNS topics to associate with the notification rule.
    • items Target

Output

• output CreateNotificationRuleResult

DeleteNotificationRule

amazonaws_codestar_notifications.DeleteNotificationRule({
  "Arn": ""
}, context)

Input

• input object
  • Arn required string: The Amazon Resource Name (ARN) of the notification rule you want to delete.

Output

• output DeleteNotificationRuleResult

DeleteTarget

amazonaws_codestar_notifications.DeleteTarget({
  "TargetAddress": ""
}, context)

Input

• input object
  • ForceUnsubscribeAll boolean: A Boolean value that can be used to delete all associations with this SNS topic. The default value is FALSE. If set to TRUE, all associations between that target and every notification rule in your AWS account are deleted.
  • TargetAddress required string: The Amazon Resource Name (ARN) of the SNS topic to delete.

Output

• output DeleteTargetResult

DescribeNotificationRule

amazonaws_codestar_notifications.DescribeNotificationRule({
  "Arn": ""
}, context)

Input

• input object
  • Arn required string: The Amazon Resource Name (ARN) of the notification rule.

Output

• output DescribeNotificationRuleResult

ListEventTypes

amazonaws_codestar_notifications.ListEventTypes({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • Filters array: The filters to use to return information by service or resource type.
    • items ListEventTypesFilter
  • MaxResults integer: 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.
  • NextToken string: An enumeration token that, when provided in a request, returns the next batch of the results.

Output

• output ListEventTypesResult

ListNotificationRules

amazonaws_codestar_notifications.ListNotificationRules({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • Filters array: The filters to use to return information by service or resource type. For valid values, see ListNotificationRulesFilter. 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.
    • items ListNotificationRulesFilter
  • MaxResults integer: A non-negative integer used to limit the number of returned results. The maximum number of results that can be returned is 100.
  • NextToken string: An enumeration token that, when provided in a request, returns the next batch of the results.

Output

• output ListNotificationRulesResult

ListTagsForResource

amazonaws_codestar_notifications.ListTagsForResource({
  "Arn": ""
}, context)

Input

• input object
  • Arn required string: The Amazon Resource Name (ARN) for the notification rule.

Output

• output ListTagsForResourceResult

ListTargets

amazonaws_codestar_notifications.ListTargets({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • Filters array: The filters to use to return information by service or resource type. Valid filters include target type, target address, and target status. 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.
    • items ListTargetsFilter
  • MaxResults integer: A non-negative integer used to limit the number of returned results. The maximum number of results that can be returned is 100.
  • NextToken string: An enumeration token that, when provided in a request, returns the next batch of the results.

Output

• output ListTargetsResult

Subscribe

amazonaws_codestar_notifications.Subscribe({
  "Arn": "",
  "Target": {}
}, context)

Input

• input object
  • Arn required string: The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.
  • ClientRequestToken string: An enumeration token that, when provided in a request, returns the next batch of the results.
  • Target required object: Information about the SNS topics associated with a notification rule.
    • TargetAddress
    • TargetType

Output

• output SubscribeResult

TagResource

amazonaws_codestar_notifications.TagResource({
  "Arn": "",
  "Tags": {}
}, context)

Input

• input object
  • Arn required string: The Amazon Resource Name (ARN) of the notification rule to tag.
  • Tags required object: The list of tags to associate with the resource. Tag key names cannot start with "aws".

Output

• output TagResourceResult

Unsubscribe

amazonaws_codestar_notifications.Unsubscribe({
  "Arn": "",
  "TargetAddress": ""
}, context)

Input

• input object
  • Arn required string: The Amazon Resource Name (ARN) of the notification rule.
  • TargetAddress required string: The ARN of the SNS topic to unsubscribe from the notification rule.

Output

• output UnsubscribeResult

UntagResource

amazonaws_codestar_notifications.UntagResource({
  "Arn": "",
  "TagKeys": []
}, context)

Input

• input object
  • Arn required string: The Amazon Resource Name (ARN) of the notification rule from which to remove the tags.
  • TagKeys required array: The key names of the tags to remove.
    • items TagKey

Output

• output UntagResourceResult

UpdateNotificationRule

amazonaws_codestar_notifications.UpdateNotificationRule({
  "Arn": ""
}, context)

Input

• input object
  • Arn required string: The Amazon Resource Name (ARN) of the notification rule.
  • DetailType string (values: BASIC, FULL): 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 AWS 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.
  • EventTypeIds array: A list of event types associated with this notification rule.
    • items EventTypeId
  • Name string: The name of the notification rule.
  • Status string (values: ENABLED, DISABLED): The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (not sending notifications).
  • Targets array: The address and type of the targets to receive notifications from this notification rule.
    • items Target

Output

• output UpdateNotificationRuleResult

Definitions

AccessDeniedException

ClientRequestToken

• ClientRequestToken string

ConcurrentModificationException

ConfigurationException

CreateNotificationRuleRequest

• CreateNotificationRuleRequest object
  • ClientRequestToken
  • DetailType required
  • EventTypeIds required
    • items EventTypeId
  • Name required
  • Resource required
  • Status
  • Tags
  • Targets required
    • items Target

CreateNotificationRuleResult

• CreateNotificationRuleResult object
  • Arn

CreatedTimestamp

• CreatedTimestamp string

DeleteNotificationRuleRequest

• DeleteNotificationRuleRequest object
  • Arn required

DeleteNotificationRuleResult

• DeleteNotificationRuleResult object
  • Arn

DeleteTargetRequest

• DeleteTargetRequest object
  • ForceUnsubscribeAll
  • TargetAddress required

DeleteTargetResult

• DeleteTargetResult object

DescribeNotificationRuleRequest

• DescribeNotificationRuleRequest object
  • Arn required

DescribeNotificationRuleResult

• DescribeNotificationRuleResult object
  • Arn required
  • CreatedBy
  • CreatedTimestamp
  • DetailType
  • EventTypes
    • items EventTypeSummary
  • LastModifiedTimestamp
  • Name
  • Resource
  • Status
  • Tags
  • Targets
    • items TargetSummary

DetailType

• DetailType string (values: BASIC, FULL)

EventTypeBatch

• EventTypeBatch array
  • items EventTypeSummary

EventTypeId

• EventTypeId string

EventTypeIds

• EventTypeIds array
  • items EventTypeId

EventTypeName

• EventTypeName string

EventTypeSummary

• EventTypeSummary object: Returns information about an event that has triggered a notification rule.
  • EventTypeId
  • EventTypeName
  • ResourceType
  • ServiceName

ForceUnsubscribeAll

• ForceUnsubscribeAll boolean

InvalidNextTokenException

LastModifiedTimestamp

• LastModifiedTimestamp string

LimitExceededException

ListEventTypesFilter

• ListEventTypesFilter object: Information about a filter to apply to the list of returned event types. You can filter by resource type or service name.
  • Name required
  • Value required

ListEventTypesFilterName

• ListEventTypesFilterName string (values: RESOURCE_TYPE, SERVICE_NAME)

ListEventTypesFilterValue

• ListEventTypesFilterValue string

ListEventTypesFilters

• ListEventTypesFilters array
  • items ListEventTypesFilter

ListEventTypesRequest

• ListEventTypesRequest object
  • Filters
    • items ListEventTypesFilter
  • MaxResults
  • NextToken

ListEventTypesResult

• ListEventTypesResult object
  • EventTypes
    • items EventTypeSummary
  • NextToken

ListNotificationRulesFilter

• ListNotificationRulesFilter object: Information about a filter to apply to the list of returned notification rules. You can filter by event type, owner, resource, or target.
  • Name required
  • Value required

ListNotificationRulesFilterName

• ListNotificationRulesFilterName string (values: EVENT_TYPE_ID, CREATED_BY, RESOURCE, TARGET_ADDRESS)

ListNotificationRulesFilterValue

• ListNotificationRulesFilterValue string

ListNotificationRulesFilters

• ListNotificationRulesFilters array
  • items ListNotificationRulesFilter

ListNotificationRulesRequest

• ListNotificationRulesRequest object
  • Filters
    • items ListNotificationRulesFilter
  • MaxResults
  • NextToken

ListNotificationRulesResult

• ListNotificationRulesResult object
  • NextToken
  • NotificationRules
    • items NotificationRuleSummary

ListTagsForResourceRequest

• ListTagsForResourceRequest object
  • Arn required

ListTagsForResourceResult

• ListTagsForResourceResult object
  • Tags

ListTargetsFilter

• ListTargetsFilter object: 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 Amazon SNS topics as targets, you could specify a ListTargetsFilter Name as TargetType and a Value of SNS, and a Name of TARGET_STATUS and a Value of ACTIVE.
  • Name required
  • Value required

ListTargetsFilterName

• ListTargetsFilterName string (values: TARGET_TYPE, TARGET_ADDRESS, TARGET_STATUS)

ListTargetsFilterValue

• ListTargetsFilterValue string

ListTargetsFilters

• ListTargetsFilters array
  • items ListTargetsFilter

ListTargetsRequest

• ListTargetsRequest object
  • Filters
    • items ListTargetsFilter
  • MaxResults
  • NextToken

ListTargetsResult

• ListTargetsResult object
  • NextToken
  • Targets
    • items TargetSummary

MaxResults

• MaxResults integer

NextToken

• NextToken string

NotificationRuleArn

• NotificationRuleArn string

NotificationRuleBatch

• NotificationRuleBatch array
  • items NotificationRuleSummary

NotificationRuleCreatedBy

• NotificationRuleCreatedBy string

NotificationRuleId

• NotificationRuleId string

NotificationRuleName

• NotificationRuleName string

NotificationRuleResource

• NotificationRuleResource string

NotificationRuleStatus

• NotificationRuleStatus string (values: ENABLED, DISABLED)

NotificationRuleSummary

• NotificationRuleSummary object: Information about a specified notification rule.
  • Arn
  • Id

ResourceAlreadyExistsException

ResourceNotFoundException

ResourceType

• ResourceType string

ServiceName

• ServiceName string

SubscribeRequest

• SubscribeRequest object
  • Arn required
  • ClientRequestToken
  • Target required Target

SubscribeResult

• SubscribeResult object
  • Arn

TagKey

• TagKey string

TagKeys

• TagKeys array
  • items TagKey

TagResourceRequest

• TagResourceRequest object
  • Arn required
  • Tags required

TagResourceResult

• TagResourceResult object
  • Tags

TagValue

• TagValue string

Tags

• Tags object

Target

• Target object: Information about the SNS topics associated with a notification rule.
  • TargetAddress
  • TargetType

TargetAddress

• TargetAddress string

TargetStatus

• TargetStatus string (values: PENDING, ACTIVE, UNREACHABLE, INACTIVE, DEACTIVATED)

TargetSummary

• TargetSummary object: Information about the targets specified for a notification rule.
  • TargetAddress
  • TargetStatus
  • TargetType

TargetType

• TargetType string

Targets

• Targets array
  • items Target

TargetsBatch

• TargetsBatch array
  • items TargetSummary

UnsubscribeRequest

• UnsubscribeRequest object
  • Arn required
  • TargetAddress required

UnsubscribeResult

• UnsubscribeResult object
  • Arn required

UntagResourceRequest

• UntagResourceRequest object
  • Arn required
  • TagKeys required
    • items TagKey

UntagResourceResult

• UntagResourceResult object

UpdateNotificationRuleRequest

• UpdateNotificationRuleRequest object
  • Arn required
  • DetailType
  • EventTypeIds
    • items EventTypeId
  • Name
  • Status
  • Targets
    • items Target

UpdateNotificationRuleResult

• UpdateNotificationRuleResult object

ValidationException