Class: AWS.CodeStarNotifications

var params = {
  Arn: 'STRING_VALUE' /* required */
};
codestarnotifications.deleteNotificationRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Arn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Arn — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  TargetAddress: 'STRING_VALUE', /* required */
  ForceUnsubscribeAll: true || false
};
codestarnotifications.deleteTarget(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TargetAddress — (String)

    The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client to delete.

  • ForceUnsubscribeAll — (Boolean)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Arn: 'STRING_VALUE' /* required */
};
codestarnotifications.describeNotificationRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Arn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Arn — (String)

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

    • Name — (String)

      The name of the notification rule.

    • EventTypes — (Array<map>)

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

      • EventTypeId — (String)

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

      • ServiceName — (String)

        The name of the service for which the event applies.

      • EventTypeName — (String)

        The name of the event.

      • ResourceType — (String)

        The resource type of the event.

    • Resource — (String)

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

    • Targets — (Array<map>)

      A list of the Chatbot topics and Chatbot clients associated with the notification rule.

      • TargetAddress — (String)

        The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.

      • TargetType — (String)

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

        • Chatbot topics are specified as SNS.

        • Chatbot clients are specified as AWSChatbotSlack.

      • TargetStatus — (String)

        The status of the target.

        Possible values include:
        • "PENDING"
        • "ACTIVE"
        • "UNREACHABLE"
        • "INACTIVE"
        • "DEACTIVATED"
    • DetailType — (String)

      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.

      Possible values include:
      • "BASIC"
      • "FULL"
    • CreatedBy — (String)

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

    • Status — (String)

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

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • CreatedTimestamp — (Date)

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

    • LastModifiedTimestamp — (Date)

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

    • Tags — (map<String>)

      The tags associated with the notification rule.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Filters: [
    {
      Name: RESOURCE_TYPE | SERVICE_NAME, /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
codestarnotifications.listEventTypes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filters — (Array<map>)

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

    • Name — required — (String)

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

      Possible values include:
      • "RESOURCE_TYPE"
      • "SERVICE_NAME"
    • Value — required — (String)

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

  • NextToken — (String)

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

  • 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • EventTypes — (Array<map>)

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

      • EventTypeId — (String)

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

      • ServiceName — (String)

        The name of the service for which the event applies.

      • EventTypeName — (String)

        The name of the event.

      • ResourceType — (String)

        The resource type of the event.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Filters: [
    {
      Name: EVENT_TYPE_ID | CREATED_BY | RESOURCE | TARGET_ADDRESS, /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
codestarnotifications.listNotificationRules(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filters — (Array<map>)

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

    Note: 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.
    • Name — required — (String)

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

      Possible values include:
      • "EVENT_TYPE_ID"
      • "CREATED_BY"
      • "RESOURCE"
      • "TARGET_ADDRESS"
    • Value — required — (String)

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

  • NextToken — (String)

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

  • 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

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

    • NotificationRules — (Array<map>)

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

      • Id — (String)

        The unique ID of the notification rule.

      • Arn — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Arn: 'STRING_VALUE' /* required */
};
codestarnotifications.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Arn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (map<String>)

      The tags associated with the notification rule.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Filters: [
    {
      Name: TARGET_TYPE | TARGET_ADDRESS | TARGET_STATUS, /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
codestarnotifications.listTargets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filters — (Array<map>)

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

    Note: 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.
    • Name — required — (String)

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

      Possible values include:
      • "TARGET_TYPE"
      • "TARGET_ADDRESS"
      • "TARGET_STATUS"
    • Value — required — (String)

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

  • NextToken — (String)

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

  • 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Targets — (Array<map>)

      The list of notification rule targets.

      • TargetAddress — (String)

        The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.

      • TargetType — (String)

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

        • Chatbot topics are specified as SNS.

        • Chatbot clients are specified as AWSChatbotSlack.

      • TargetStatus — (String)

        The status of the target.

        Possible values include:
        • "PENDING"
        • "ACTIVE"
        • "UNREACHABLE"
        • "INACTIVE"
        • "DEACTIVATED"
    • NextToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Arn: 'STRING_VALUE', /* required */
  Target: { /* required */
    TargetAddress: 'STRING_VALUE',
    TargetType: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE'
};
codestarnotifications.subscribe(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Arn — (String)

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

  • Target — (map)

    Information about the Chatbot topics or Chatbot clients associated with a notification rule.

    • TargetType — (String)

      The target type. Can be an Chatbot topic or Chatbot client.

      • Chatbot topics are specified as SNS.

      • Chatbot clients are specified as AWSChatbotSlack.

    • TargetAddress — (String)

      The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.

  • ClientRequestToken — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Arn — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Arn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
codestarnotifications.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Arn — (String)

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

  • Tags — (map<String>)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (map<String>)

      The list of tags associated with the resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Arn: 'STRING_VALUE', /* required */
  TargetAddress: 'STRING_VALUE' /* required */
};
codestarnotifications.unsubscribe(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Arn — (String)

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

  • TargetAddress — (String)

    The ARN of the Chatbot topic to unsubscribe from the notification rule.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Arn — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Arn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
codestarnotifications.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Arn — (String)

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

  • TagKeys — (Array<String>)

    The key names of the tags to remove.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Arn: 'STRING_VALUE', /* required */
  DetailType: BASIC | FULL,
  EventTypeIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Name: 'STRING_VALUE',
  Status: ENABLED | DISABLED,
  Targets: [
    {
      TargetAddress: 'STRING_VALUE',
      TargetType: 'STRING_VALUE'
    },
    /* more items */
  ]
};
codestarnotifications.updateNotificationRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Arn — (String)

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

  • Name — (String)

    The name of the notification rule.

  • Status — (String)

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

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • EventTypeIds — (Array<String>)

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

  • Targets — (Array<map>)

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

    • TargetType — (String)

      The target type. Can be an Chatbot topic or Chatbot client.

      • Chatbot topics are specified as SNS.

      • Chatbot clients are specified as AWSChatbotSlack.

    • TargetAddress — (String)

      The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.

  • DetailType — (String)

    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.

    Possible values include:
    • "BASIC"
    • "FULL"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.