Class: AWS.CloudWatchEvents

Inherits:
AWS.Service show all
Identifier:
cloudwatchevents
API Version:
2015-10-07
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon CloudWatch Events helps you to respond to state changes in your AWS resources. When your resources change state, they automatically send events into an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a predetermined schedule. For example, you can configure rules to:

  • Automatically invoke an AWS Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.

  • Direct specific API records from AWS CloudTrail to an Amazon Kinesis data stream for detailed analysis of potential security or availability risks.

  • Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.

For more information about the features of Amazon CloudWatch Events, see the Amazon CloudWatch Events User Guide.

Sending a Request Using CloudWatchEvents

var cloudwatchevents = new AWS.CloudWatchEvents();
cloudwatchevents.listRuleNamesByTarget(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CloudWatchEvents object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var cloudwatchevents = new AWS.CloudWatchEvents({apiVersion: '2015-10-07'});

You can also set the API version globally in AWS.config.apiVersions using the cloudwatchevents service identifier:

AWS.config.apiVersions = {
  cloudwatchevents: '2015-10-07',
  // other service API versions
};

var cloudwatchevents = new AWS.CloudWatchEvents();

Version:

  • 2015-10-07

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.CloudWatchEvents(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a CloudWatchEvents object

var cloudwatchevents = new AWS.CloudWatchEvents({apiVersion: '2015-10-07'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.CloudWatchEvents.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.CloudWatchEvents.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.CloudWatchEvents.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

deleteRule(params = {}, callback) ⇒ AWS.Request

Deletes the specified rule.

Before you can delete the rule, you must remove all targets, using RemoveTargets.

When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.

Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule.

Service Reference:

Examples:

Calling the deleteRule operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Force: true || false
};
cloudwatchevents.deleteRule(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: {}) —
    • Name — (String)

      The name of the rule.

    • Force — (Boolean)

      If this is a managed rule, created by an AWS service on your behalf, you must specify Force as True to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.

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.

describeEventBus(params = {}, callback) ⇒ AWS.Request

Displays the external AWS accounts that are permitted to write events to your account using your account's event bus, and the associated policy. To enable your account to receive events from other accounts, use PutPermission.

Service Reference:

Examples:

Calling the describeEventBus operation

var params = {
};
cloudwatchevents.describeEventBus(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: {})

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:

      • Name — (String)

        The name of the event bus. Currently, this is always default.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the account permitted to write events to the current account.

      • Policy — (String)

        The policy that enables the external account to send events to your account.

Returns:

  • (AWS.Request) —

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

describeRule(params = {}, callback) ⇒ AWS.Request

Describes the specified rule.

DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

Service Reference:

Examples:

Calling the describeRule operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
cloudwatchevents.describeRule(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: {}) —
    • Name — (String)

      The name of the 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:

      • Name — (String)

        The name of the rule.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the rule.

      • EventPattern — (String)

        The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.

      • ScheduleExpression — (String)

        The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

      • State — (String)

        Specifies whether the rule is enabled or disabled.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • Description — (String)

        The description of the rule.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM role associated with the rule.

      • ManagedBy — (String)

        If this is a managed rule, created by an AWS service on your behalf, this field displays the principal name of the AWS service that created the rule.

Returns:

  • (AWS.Request) —

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

disableRule(params = {}, callback) ⇒ AWS.Request

Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.

When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect.

Service Reference:

Examples:

Calling the disableRule operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
cloudwatchevents.disableRule(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: {}) —
    • Name — (String)

      The name of the 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.

Returns:

  • (AWS.Request) —

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

enableRule(params = {}, callback) ⇒ AWS.Request

Enables the specified rule. If the rule does not exist, the operation fails.

When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect.

Service Reference:

Examples:

Calling the enableRule operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
cloudwatchevents.enableRule(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: {}) —
    • Name — (String)

      The name of the 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.

Returns:

  • (AWS.Request) —

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

listRuleNamesByTarget(params = {}, callback) ⇒ AWS.Request

Lists the rules for the specified target. You can see which of the rules in Amazon CloudWatch Events can invoke a specific target in your account.

Service Reference:

Examples:

Calling the listRuleNamesByTarget operation

var params = {
  TargetArn: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
cloudwatchevents.listRuleNamesByTarget(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: {}) —
    • TargetArn — (String)

      The Amazon Resource Name (ARN) of the target resource.

    • NextToken — (String)

      The token returned by a previous call to retrieve the next set of results.

    • Limit — (Integer)

      The maximum number of results to return.

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:

      • RuleNames — (Array<String>)

        The names of the rules that can invoke the given target.

      • NextToken — (String)

        Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

Returns:

  • (AWS.Request) —

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

listRules(params = {}, callback) ⇒ AWS.Request

Lists your Amazon CloudWatch Events rules. You can either list all the rules or you can provide a prefix to match to the rule names.

ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

Service Reference:

Examples:

Calling the listRules operation

var params = {
  Limit: 'NUMBER_VALUE',
  NamePrefix: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
cloudwatchevents.listRules(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: {}) —
    • NamePrefix — (String)

      The prefix matching the rule name.

    • NextToken — (String)

      The token returned by a previous call to retrieve the next set of results.

    • Limit — (Integer)

      The maximum number of results to return.

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:

      • Rules — (Array<map>)

        The rules that match the specified criteria.

        • Name — (String)

          The name of the rule.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the rule.

        • EventPattern — (String)

          The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.

        • State — (String)

          The state of the rule.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • Description — (String)

          The description of the rule.

        • ScheduleExpression — (String)

          The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

        • RoleArn — (String)

          The Amazon Resource Name (ARN) of the role that is used for target invocation.

        • ManagedBy — (String)

          If the rule was created on behalf of your account by an AWS service, this field displays the principal name of the service that created the rule.

      • NextToken — (String)

        Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

Returns:

  • (AWS.Request) —

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Displays the tags associated with a CloudWatch Events resource. In CloudWatch Events, rules can be tagged.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
cloudwatchevents.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: {}) —
    • ResourceARN — (String)

      The ARN of the CloudWatch Events rule for which you want to view tags.

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 — (Array<map>)

        The list of tag keys and values associated with the rule you specified

        • Key — required — (String)

          A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

        • Value — required — (String)

          The value for the specified tag key.

Returns:

  • (AWS.Request) —

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

listTargetsByRule(params = {}, callback) ⇒ AWS.Request

Lists the targets assigned to the specified rule.

Service Reference:

Examples:

Calling the listTargetsByRule operation

var params = {
  Rule: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
cloudwatchevents.listTargetsByRule(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: {}) —
    • Rule — (String)

      The name of the rule.

    • NextToken — (String)

      The token returned by a previous call to retrieve the next set of results.

    • Limit — (Integer)

      The maximum number of results to return.

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 targets assigned to the rule.

        • Id — required — (String)

          The ID of the target.

        • Arn — required — (String)

          The Amazon Resource Name (ARN) of the target.

        • RoleArn — (String)

          The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.

        • Input — (String)

          Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

        • InputPath — (String)

          The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath.

        • InputTransformer — (map)

          Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.

          • InputPathsMap — (map<String>)

            Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

            InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

            The keys cannot start with "AWS."

          • InputTemplate — required — (String)

            Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value> The InputTemplate must be valid JSON.

            If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

            • The placeholder cannot be used as an object key.

            • Object values cannot include quote marks.

            The following example shows the syntax for using InputPathsMap and InputTemplate.

            "InputTransformer":

            {

            "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

            "InputTemplate": "<instance> is in state <status>"

            }

            To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

            "InputTransformer":

            {

            "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

            "InputTemplate": "<instance> is in state \"<status>\""

            }

        • KinesisParameters — (map)

          The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the eventId as the partition key.

          • PartitionKeyPath — required — (String)

            The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

        • RunCommandParameters — (map)

          Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

          • RunCommandTargets — required — (Array<map>)

            Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.

            • Key — required — (String)

              Can be either tag: tag-key or InstanceIds.

            • Values — required — (Array<String>)

              If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, Values is a list of Amazon EC2 instance IDs.

        • EcsParameters — (map)

          Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.

          • TaskDefinitionArn — required — (String)

            The ARN of the task definition to use if the event target is an Amazon ECS task.

          • TaskCount — (Integer)

            The number of tasks to create based on TaskDefinition. The default is 1.

          • LaunchType — (String)

            Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

            Possible values include:
            • "EC2"
            • "FARGATE"
          • NetworkConfiguration — (map)

            Use this structure if the ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.

            If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

            • awsvpcConfiguration — (map)

              Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.

              • Subnets — required — (Array<String>)

                Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.

              • SecurityGroups — (Array<String>)

                Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.

              • AssignPublicIp — (String)

                Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE.

                Possible values include:
                • "ENABLED"
                • "DISABLED"
          • PlatformVersion — (String)

            Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

            This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

          • Group — (String)

            Specifies an ECS task group for the task. The maximum length is 255 characters.

        • BatchParameters — (map)

          If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide.

          • JobDefinition — required — (String)

            The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.

          • JobName — required — (String)

            The name to use for this execution of the job, if the target is an AWS Batch job.

          • ArrayProperties — (map)

            The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.

            • Size — (Integer)

              The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.

          • RetryStrategy — (map)

            The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

            • Attempts — (Integer)

              The number of times to attempt to retry, if the job fails. Valid values are 1–10.

        • SqsParameters — (map)

          Contains the message group ID to use when the target is a FIFO queue.

          If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.

          • MessageGroupId — (String)

            The FIFO message group ID to use as the target.

      • NextToken — (String)

        Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

Returns:

  • (AWS.Request) —

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

putEvents(params = {}, callback) ⇒ AWS.Request

Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.

Service Reference:

Examples:

Calling the putEvents operation

var params = {
  Entries: [ /* required */
    {
      Detail: 'STRING_VALUE',
      DetailType: 'STRING_VALUE',
      Resources: [
        'STRING_VALUE',
        /* more items */
      ],
      Source: 'STRING_VALUE',
      Time: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
    },
    /* more items */
  ]
};
cloudwatchevents.putEvents(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: {}) —
    • Entries — (Array<map>)

      The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.

      • Time — (Date)

        The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

      • Source — (String)

        The source of the event. This field is required.

      • Resources — (Array<String>)

        AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

      • DetailType — (String)

        Free-form string used to decide what fields to expect in the event detail.

      • Detail — (String)

        A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects.

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:

      • FailedEntryCount — (Integer)

        The number of failed entries.

      • Entries — (Array<map>)

        The successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

        • EventId — (String)

          The ID of the event.

        • ErrorCode — (String)

          The error code that indicates why the event submission failed.

        • ErrorMessage — (String)

          The error message that explains why the event submission failed.

Returns:

  • (AWS.Request) —

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

putPermission(params = {}, callback) ⇒ AWS.Request

Running PutPermission permits the specified AWS account or AWS organization to put events to your account's default event bus. CloudWatch Events rules in your account are triggered by these events arriving to your default event bus.

For another account to send events to your account, that external account must have a CloudWatch Events rule with your account's default event bus as a target.

To enable multiple AWS accounts to put events to your default event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as "*" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization.

If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon CloudWatch Events User Guide.

The permission policy on the default event bus cannot exceed 10 KB in size.

Service Reference:

Examples:

Calling the putPermission operation

var params = {
  Action: 'STRING_VALUE', /* required */
  Principal: 'STRING_VALUE', /* required */
  StatementId: 'STRING_VALUE', /* required */
  Condition: {
    Key: 'STRING_VALUE', /* required */
    Type: 'STRING_VALUE', /* required */
    Value: 'STRING_VALUE' /* required */
  }
};
cloudwatchevents.putPermission(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: {}) —
    • Action — (String)

      The action that you are enabling the other account to perform. Currently, this must be events:PutEvents.

    • Principal — (String)

      The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "" to permit any account to put events to your default event bus.

      If you specify "" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

    • StatementId — (String)

      An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

    • Condition — (map)

      This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations in the AWS Organizations User Guide.

      If you specify Condition with an AWS organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization.

      The Condition is a JSON string which must contain Type, Key, and Value fields.

      • Type — required — (String)

        Specifies the type of condition. Currently the only supported value is StringEquals.

      • Key — required — (String)

        Specifies the key for the condition. Currently the only supported key is aws:PrincipalOrgID.

      • Value — required — (String)

        Specifies the value for the key. Currently, this must be the ID of the organization.

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.

putRule(params = {}, callback) ⇒ AWS.Request

Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule.

If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values.

When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.

A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.

When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions.

If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.

Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

In CloudWatch Events, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.

To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.

An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.

Service Reference:

Examples:

Calling the putRule operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  EventPattern: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  ScheduleExpression: 'STRING_VALUE',
  State: ENABLED | DISABLED,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
cloudwatchevents.putRule(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: {}) —
    • Name — (String)

      The name of the rule that you are creating or updating.

    • ScheduleExpression — (String)

      The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

    • EventPattern — (String)

      The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.

    • State — (String)

      Indicates whether the rule is enabled or disabled.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • Description — (String)

      A description of the rule.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role associated with the rule.

    • Tags — (Array<map>)

      The list of key-value pairs to associate with the rule.

      • Key — required — (String)

        A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

      • Value — required — (String)

        The value for the specified tag key.

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:

      • RuleArn — (String)

        The Amazon Resource Name (ARN) of the rule.

Returns:

  • (AWS.Request) —

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

putTargets(params = {}, callback) ⇒ AWS.Request

Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

Targets are the resources that are invoked when a rule is triggered.

You can configure the following as targets for CloudWatch Events:

  • EC2 instances

  • SSM Run Command

  • SSM Automation

  • AWS Lambda functions

  • Data streams in Amazon Kinesis Data Streams

  • Data delivery streams in Amazon Kinesis Data Firehose

  • Amazon ECS tasks

  • AWS Step Functions state machines

  • AWS Batch jobs

  • AWS CodeBuild projects

  • Pipelines in AWS CodePipeline

  • Amazon Inspector assessment templates

  • Amazon SNS topics

  • Amazon SQS queues, including FIFO queues

  • The default event bus of another AWS account

Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call.

For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.

To be able to make API calls against the resources that you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For EC2 instances, Kinesis data streams, and AWS Step Functions state machines, CloudWatch Events relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon CloudWatch Events User Guide.

If another AWS account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon CloudWatch Pricing.

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon CloudWatch Events User Guide.

For more information about enabling cross-account events, see PutPermission.

Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:

  • If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).

  • If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.

  • If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).

  • If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation.

When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.

This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

Service Reference:

Examples:

Calling the putTargets operation

var params = {
  Rule: 'STRING_VALUE', /* required */
  Targets: [ /* required */
    {
      Arn: 'STRING_VALUE', /* required */
      Id: 'STRING_VALUE', /* required */
      BatchParameters: {
        JobDefinition: 'STRING_VALUE', /* required */
        JobName: 'STRING_VALUE', /* required */
        ArrayProperties: {
          Size: 'NUMBER_VALUE'
        },
        RetryStrategy: {
          Attempts: 'NUMBER_VALUE'
        }
      },
      EcsParameters: {
        TaskDefinitionArn: 'STRING_VALUE', /* required */
        Group: 'STRING_VALUE',
        LaunchType: EC2 | FARGATE,
        NetworkConfiguration: {
          awsvpcConfiguration: {
            Subnets: [ /* required */
              'STRING_VALUE',
              /* more items */
            ],
            AssignPublicIp: ENABLED | DISABLED,
            SecurityGroups: [
              'STRING_VALUE',
              /* more items */
            ]
          }
        },
        PlatformVersion: 'STRING_VALUE',
        TaskCount: 'NUMBER_VALUE'
      },
      Input: 'STRING_VALUE',
      InputPath: 'STRING_VALUE',
      InputTransformer: {
        InputTemplate: 'STRING_VALUE', /* required */
        InputPathsMap: {
          '<InputTransformerPathKey>': 'STRING_VALUE',
          /* '<InputTransformerPathKey>': ... */
        }
      },
      KinesisParameters: {
        PartitionKeyPath: 'STRING_VALUE' /* required */
      },
      RoleArn: 'STRING_VALUE',
      RunCommandParameters: {
        RunCommandTargets: [ /* required */
          {
            Key: 'STRING_VALUE', /* required */
            Values: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* more items */
        ]
      },
      SqsParameters: {
        MessageGroupId: 'STRING_VALUE'
      }
    },
    /* more items */
  ]
};
cloudwatchevents.putTargets(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: {}) —
    • Rule — (String)

      The name of the rule.

    • Targets — (Array<map>)

      The targets to update or add to the rule.

      • Id — required — (String)

        The ID of the target.

      • Arn — required — (String)

        The Amazon Resource Name (ARN) of the target.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.

      • Input — (String)

        Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

      • InputPath — (String)

        The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath.

      • InputTransformer — (map)

        Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.

        • InputPathsMap — (map<String>)

          Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

          InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

          The keys cannot start with "AWS."

        • InputTemplate — required — (String)

          Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value> The InputTemplate must be valid JSON.

          If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

          • The placeholder cannot be used as an object key.

          • Object values cannot include quote marks.

          The following example shows the syntax for using InputPathsMap and InputTemplate.

          "InputTransformer":

          {

          "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

          "InputTemplate": "<instance> is in state <status>"

          }

          To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

          "InputTransformer":

          {

          "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

          "InputTemplate": "<instance> is in state \"<status>\""

          }

      • KinesisParameters — (map)

        The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the eventId as the partition key.

        • PartitionKeyPath — required — (String)

          The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

      • RunCommandParameters — (map)

        Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

        • RunCommandTargets — required — (Array<map>)

          Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.

          • Key — required — (String)

            Can be either tag: tag-key or InstanceIds.

          • Values — required — (Array<String>)

            If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, Values is a list of Amazon EC2 instance IDs.

      • EcsParameters — (map)

        Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.

        • TaskDefinitionArn — required — (String)

          The ARN of the task definition to use if the event target is an Amazon ECS task.

        • TaskCount — (Integer)

          The number of tasks to create based on TaskDefinition. The default is 1.

        • LaunchType — (String)

          Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

          Possible values include:
          • "EC2"
          • "FARGATE"
        • NetworkConfiguration — (map)

          Use this structure if the ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.

          If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

          • awsvpcConfiguration — (map)

            Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.

            • Subnets — required — (Array<String>)

              Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.

            • SecurityGroups — (Array<String>)

              Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.

            • AssignPublicIp — (String)

              Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
        • PlatformVersion — (String)

          Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

          This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

        • Group — (String)

          Specifies an ECS task group for the task. The maximum length is 255 characters.

      • BatchParameters — (map)

        If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide.

        • JobDefinition — required — (String)

          The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.

        • JobName — required — (String)

          The name to use for this execution of the job, if the target is an AWS Batch job.

        • ArrayProperties — (map)

          The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.

          • Size — (Integer)

            The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.

        • RetryStrategy — (map)

          The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

          • Attempts — (Integer)

            The number of times to attempt to retry, if the job fails. Valid values are 1–10.

      • SqsParameters — (map)

        Contains the message group ID to use when the target is a FIFO queue.

        If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.

        • MessageGroupId — (String)

          The FIFO message group ID to use as the target.

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:

      • FailedEntryCount — (Integer)

        The number of failed entries.

      • FailedEntries — (Array<map>)

        The failed target entries.

        • TargetId — (String)

          The ID of the target.

        • ErrorCode — (String)

          The error code that indicates why the target addition failed. If the value is ConcurrentModificationException, too many requests were made at the same time.

        • ErrorMessage — (String)

          The error message that explains why the target addition failed.

Returns:

  • (AWS.Request) —

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

removePermission(params = {}, callback) ⇒ AWS.Request

Revokes the permission of another AWS account to be able to put events to your default event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus.

Service Reference:

Examples:

Calling the removePermission operation

var params = {
  StatementId: 'STRING_VALUE' /* required */
};
cloudwatchevents.removePermission(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: {}) —
    • StatementId — (String)

      The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.

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.

removeTargets(params = {}, callback) ⇒ AWS.Request

Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.

When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect.

This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

Service Reference:

Examples:

Calling the removeTargets operation

var params = {
  Ids: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Rule: 'STRING_VALUE', /* required */
  Force: true || false
};
cloudwatchevents.removeTargets(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: {}) —
    • Rule — (String)

      The name of the rule.

    • Ids — (Array<String>)

      The IDs of the targets to remove from the rule.

    • Force — (Boolean)

      If this is a managed rule, created by an AWS service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.

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:

      • FailedEntryCount — (Integer)

        The number of failed entries.

      • FailedEntries — (Array<map>)

        The failed target entries.

        • TargetId — (String)

          The ID of the target.

        • ErrorCode — (String)

          The error code that indicates why the target removal failed. If the value is ConcurrentModificationException, too many requests were made at the same time.

        • ErrorMessage — (String)

          The error message that explains why the target removal failed.

Returns:

  • (AWS.Request) —

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

tagResource(params = {}, callback) ⇒ AWS.Request

Assigns one or more tags (key-value pairs) to the specified CloudWatch Events resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In CloudWatch Events, rules can be tagged.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with a rule that already has tags. If you specify a new tag key for the rule, this tag is appended to the list of tags associated with the rule. If you specify a tag key that is already associated with the rule, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
cloudwatchevents.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: {}) —
    • ResourceARN — (String)

      The ARN of the CloudWatch Events rule that you're adding tags to.

    • Tags — (Array<map>)

      The list of key-value pairs to associate with the rule.

      • Key — required — (String)

        A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

      • Value — required — (String)

        The value for the specified tag key.

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.

testEventPattern(params = {}, callback) ⇒ AWS.Request

Tests whether the specified event pattern matches the provided event.

Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

Service Reference:

Examples:

Calling the testEventPattern operation

var params = {
  Event: 'STRING_VALUE', /* required */
  EventPattern: 'STRING_VALUE' /* required */
};
cloudwatchevents.testEventPattern(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: {}) —
    • EventPattern — (String)

      The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.

    • Event — (String)

      The event, in JSON format, to test against the event pattern.

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:

      • Result — (Boolean)

        Indicates whether the event matches the event pattern.

Returns:

  • (AWS.Request) —

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

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from the specified CloudWatch Events resource. In CloudWatch Events, rules can be tagged.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cloudwatchevents.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: {}) —
    • ResourceARN — (String)

      The ARN of the CloudWatch Events rule from which you are removing tags.

    • TagKeys — (Array<String>)

      The list of tag keys to remove from the resource.

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.