@datafire/amazonaws_events

DataFire integration for Amazon CloudWatch Events

Usage no npm install needed!

<script type="module">
  import datafireAmazonawsEvents from 'https://cdn.skypack.dev/@datafire/amazonaws_events';
</script>

README

@datafire/amazonaws_events

Client library for Amazon CloudWatch Events

Installation and Usage

npm install --save @datafire/amazonaws_events

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

amazonaws_events.DeleteRule({
  "Name": ""
}).then(data => {
  console.log(data);
});

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 pre-determined 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 CloudTrail to an Amazon Kinesis 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.

Actions

DeleteRule

amazonaws_events.DeleteRule({
  "Name": ""
}, context)

Input

Output

Output schema unknown

DescribeEventBus

amazonaws_events.DescribeEventBus({}, context)

Input

  • input object

Output

DescribeRule

amazonaws_events.DescribeRule({
  "Name": ""
}, context)

Input

Output

DisableRule

amazonaws_events.DisableRule({
  "Name": ""
}, context)

Input

Output

Output schema unknown

EnableRule

amazonaws_events.EnableRule({
  "Name": ""
}, context)

Input

Output

Output schema unknown

ListRuleNamesByTarget

amazonaws_events.ListRuleNamesByTarget({
  "TargetArn": ""
}, context)

Input

Output

ListRules

amazonaws_events.ListRules({}, context)

Input

Output

ListTargetsByRule

amazonaws_events.ListTargetsByRule({
  "Rule": ""
}, context)

Input

Output

PutEvents

amazonaws_events.PutEvents({
  "Entries": []
}, context)

Input

Output

PutPermission

amazonaws_events.PutPermission({
  "Action": "",
  "Principal": "",
  "StatementId": ""
}, context)

Input

Output

Output schema unknown

PutRule

amazonaws_events.PutRule({
  "Name": ""
}, context)

Input

Output

PutTargets

amazonaws_events.PutTargets({
  "Rule": "",
  "Targets": []
}, context)

Input

Output

RemovePermission

amazonaws_events.RemovePermission({
  "StatementId": ""
}, context)

Input

Output

Output schema unknown

RemoveTargets

amazonaws_events.RemoveTargets({
  "Rule": "",
  "Ids": []
}, context)

Input

Output

TestEventPattern

amazonaws_events.TestEventPattern({
  "EventPattern": "",
  "Event": ""
}, context)

Input

Output

Definitions

Action

  • Action string

Arn

  • Arn string

Boolean

  • Boolean boolean

ConcurrentModificationException

  • ConcurrentModificationException object: There is concurrent modification on a rule or target.

DeleteRuleRequest

  • DeleteRuleRequest object

DescribeEventBusRequest

  • DescribeEventBusRequest object

DescribeEventBusResponse

DescribeRuleRequest

  • DescribeRuleRequest object

DescribeRuleResponse

DisableRuleRequest

  • DisableRuleRequest object

EcsParameters

  • EcsParameters object: The custom parameters to be used when the target is an Amazon ECS cluster.

EnableRuleRequest

  • EnableRuleRequest object

ErrorCode

  • ErrorCode string

ErrorMessage

  • ErrorMessage string

EventId

  • EventId string

EventPattern

  • EventPattern string

EventResource

  • EventResource string

EventResourceList

EventTime

  • EventTime string

InputTransformer

  • InputTransformer object: Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.

InputTransformerPathKey

  • InputTransformerPathKey string

Integer

  • Integer integer

InternalException

  • InternalException object: This exception occurs due to unexpected causes.

InvalidEventPatternException

  • InvalidEventPatternException object: The event pattern is not valid.

KinesisParameters

  • KinesisParameters object: This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis stream, so that you can control the shard to which the event goes. If you do not include this parameter, the default is to use the eventId as the partition key.

LimitExceededException

  • LimitExceededException object: You tried to create more rules or add more targets to a rule than is allowed.

LimitMax100

  • LimitMax100 integer

LimitMin1

  • LimitMin1 integer

ListRuleNamesByTargetRequest

ListRuleNamesByTargetResponse

ListRulesRequest

ListRulesResponse

ListTargetsByRuleRequest

ListTargetsByRuleResponse

NextToken

  • NextToken string

PolicyLengthExceededException

  • PolicyLengthExceededException object: The event bus policy is too long. For more information, see the limits.

Principal

  • Principal string

PutEventsRequest

PutEventsRequestEntry

PutEventsRequestEntryList

PutEventsResponse

PutEventsResultEntry

  • PutEventsResultEntry object: Represents an event that failed to be submitted.

PutEventsResultEntryList

PutPermissionRequest

PutRuleRequest

PutRuleResponse

  • PutRuleResponse object

PutTargetsRequest

PutTargetsResponse

PutTargetsResultEntry

  • PutTargetsResultEntry object: Represents a target that failed to be added to a rule.

PutTargetsResultEntryList

RemovePermissionRequest

  • RemovePermissionRequest object

RemoveTargetsRequest

RemoveTargetsResponse

RemoveTargetsResultEntry

  • RemoveTargetsResultEntry object: Represents a target that failed to be removed from a rule.

RemoveTargetsResultEntryList

ResourceNotFoundException

  • ResourceNotFoundException object: An entity that you specified does not exist.

RoleArn

  • RoleArn string

Rule

RuleArn

  • RuleArn string

RuleDescription

  • RuleDescription string

RuleName

  • RuleName string

RuleNameList

RuleResponseList

  • RuleResponseList array

RuleState

  • RuleState string (values: ENABLED, DISABLED)

RunCommandParameters

  • RunCommandParameters object: This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.

RunCommandTarget

  • RunCommandTarget object: Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each RunCommandTarget block can include only one key, but this key may specify multiple values.

RunCommandTargetKey

  • RunCommandTargetKey string

RunCommandTargetValue

  • RunCommandTargetValue string

RunCommandTargetValues

RunCommandTargets

ScheduleExpression

  • ScheduleExpression string

StatementId

  • StatementId string

String

  • String string

Target

TargetArn

  • TargetArn string

TargetId

  • TargetId string

TargetIdList

TargetInput

  • TargetInput string

TargetInputPath

  • TargetInputPath string

TargetList

  • TargetList array

TargetPartitionKeyPath

  • TargetPartitionKeyPath string

TestEventPatternRequest

TestEventPatternResponse

  • TestEventPatternResponse object

TransformerInput

  • TransformerInput string

TransformerPaths