@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

Actions

DeleteRule

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

Input

• input object
  • Name required RuleName

Output

Output schema unknown

DescribeEventBus

amazonaws_events.DescribeEventBus({}, context)

Input

• input object

Output

• output DescribeEventBusResponse

DescribeRule

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

Input

• input object
  • Name required RuleName

Output

• output DescribeRuleResponse

DisableRule

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

Input

• input object
  • Name required RuleName

Output

Output schema unknown

EnableRule

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

Input

• input object
  • Name required RuleName

Output

Output schema unknown

ListRuleNamesByTarget

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

Input

• input object
  • Limit LimitMax100
  • NextToken NextToken
  • TargetArn required TargetArn

Output

• output ListRuleNamesByTargetResponse

ListRules

amazonaws_events.ListRules({}, context)

Input

• input object
  • Limit LimitMax100
  • NamePrefix RuleName
  • NextToken NextToken

Output

• output ListRulesResponse

ListTargetsByRule

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

Input

• input object
  • Limit LimitMax100
  • NextToken NextToken
  • Rule required RuleName

Output

• output ListTargetsByRuleResponse

PutEvents

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

Input

• input object
  • Entries required PutEventsRequestEntryList

Output

• output PutEventsResponse

PutPermission

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

Input

• input object
  • Action required Action
  • Principal required Principal
  • StatementId required StatementId

Output

Output schema unknown

PutRule

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

Input

• input object
  • Description RuleDescription
  • EventPattern EventPattern
  • Name required RuleName
  • RoleArn RoleArn
  • ScheduleExpression ScheduleExpression
  • State RuleState

Output

• output PutRuleResponse

PutTargets

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

Input

• input object
  • Rule required RuleName
  • Targets required TargetList

Output

• output PutTargetsResponse

RemovePermission

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

Input

• input object
  • StatementId required StatementId

Output

Output schema unknown

RemoveTargets

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

Input

• input object
  • Ids required TargetIdList
  • Rule required RuleName

Output

• output RemoveTargetsResponse

TestEventPattern

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

Input

• input object
  • Event required String
  • EventPattern required EventPattern

Output

• output TestEventPatternResponse

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
  • Name required RuleName

DescribeEventBusRequest

• DescribeEventBusRequest object

DescribeEventBusResponse

• DescribeEventBusResponse object
  • Arn String
  • Name String
  • Policy String

DescribeRuleRequest

• DescribeRuleRequest object
  • Name required RuleName

DescribeRuleResponse

• DescribeRuleResponse object
  • Arn RuleArn
  • Description RuleDescription
  • EventPattern EventPattern
  • Name RuleName
  • RoleArn RoleArn
  • ScheduleExpression ScheduleExpression
  • State RuleState

DisableRuleRequest

• DisableRuleRequest object
  • Name required RuleName

EcsParameters

• EcsParameters object: The custom parameters to be used when the target is an Amazon ECS cluster.
  • TaskCount LimitMin1
  • TaskDefinitionArn required Arn

EnableRuleRequest

• EnableRuleRequest object
  • Name required RuleName

ErrorCode

• ErrorCode string

ErrorMessage

• ErrorMessage string

EventId

• EventId string

EventPattern

• EventPattern string

EventResource

• EventResource string

EventResourceList

• EventResourceList array
  • items EventResource

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.
  • InputPathsMap TransformerPaths
  • InputTemplate required TransformerInput

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.
  • PartitionKeyPath required TargetPartitionKeyPath

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

• ListRuleNamesByTargetRequest object
  • Limit LimitMax100
  • NextToken NextToken
  • TargetArn required TargetArn

ListRuleNamesByTargetResponse

• ListRuleNamesByTargetResponse object
  • NextToken NextToken
  • RuleNames RuleNameList

ListRulesRequest

• ListRulesRequest object
  • Limit LimitMax100
  • NamePrefix RuleName
  • NextToken NextToken

ListRulesResponse

• ListRulesResponse object
  • NextToken NextToken
  • Rules RuleResponseList

ListTargetsByRuleRequest

• ListTargetsByRuleRequest object
  • Limit LimitMax100
  • NextToken NextToken
  • Rule required RuleName

ListTargetsByRuleResponse

• ListTargetsByRuleResponse object
  • NextToken NextToken
  • Targets TargetList

NextToken

• NextToken string

PolicyLengthExceededException

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

Principal

• Principal string

PutEventsRequest

• PutEventsRequest object
  • Entries required PutEventsRequestEntryList

PutEventsRequestEntry

• PutEventsRequestEntry object: Represents an event to be submitted.
  • Detail String
  • DetailType String
  • Resources EventResourceList
  • Source String
  • Time EventTime

PutEventsRequestEntryList

• PutEventsRequestEntryList array
  • items PutEventsRequestEntry

PutEventsResponse

• PutEventsResponse object
  • Entries PutEventsResultEntryList
  • FailedEntryCount Integer

PutEventsResultEntry

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

PutEventsResultEntryList

• PutEventsResultEntryList array
  • items PutEventsResultEntry

PutPermissionRequest

• PutPermissionRequest object
  • Action required Action
  • Principal required Principal
  • StatementId required StatementId

PutRuleRequest

• PutRuleRequest object
  • Description RuleDescription
  • EventPattern EventPattern
  • Name required RuleName
  • RoleArn RoleArn
  • ScheduleExpression ScheduleExpression
  • State RuleState

PutRuleResponse

• PutRuleResponse object
  • RuleArn RuleArn

PutTargetsRequest

• PutTargetsRequest object
  • Rule required RuleName
  • Targets required TargetList

PutTargetsResponse

• PutTargetsResponse object
  • FailedEntries PutTargetsResultEntryList
  • FailedEntryCount Integer

PutTargetsResultEntry

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

PutTargetsResultEntryList

• PutTargetsResultEntryList array
  • items PutTargetsResultEntry

RemovePermissionRequest

• RemovePermissionRequest object
  • StatementId required StatementId

RemoveTargetsRequest

• RemoveTargetsRequest object
  • Ids required TargetIdList
  • Rule required RuleName

RemoveTargetsResponse

• RemoveTargetsResponse object
  • FailedEntries RemoveTargetsResultEntryList
  • FailedEntryCount Integer

RemoveTargetsResultEntry

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

RemoveTargetsResultEntryList

• RemoveTargetsResultEntryList array
  • items RemoveTargetsResultEntry

ResourceNotFoundException

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

RoleArn

• RoleArn string

Rule

• Rule object: Contains information about a rule in Amazon CloudWatch Events.
  • Arn RuleArn
  • Description RuleDescription
  • EventPattern EventPattern
  • Name RuleName
  • RoleArn RoleArn
  • ScheduleExpression ScheduleExpression
  • State RuleState

RuleArn

• RuleArn string

RuleDescription

• RuleDescription string

RuleName

• RuleName string

RuleNameList

• RuleNameList array
  • items RuleName

RuleResponseList

• RuleResponseList array
  • items Rule

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

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.
  • Key required RunCommandTargetKey
  • Values required RunCommandTargetValues

RunCommandTargetKey

• RunCommandTargetKey string

RunCommandTargetValue

• RunCommandTargetValue string

RunCommandTargetValues

• RunCommandTargetValues array
  • items RunCommandTargetValue

RunCommandTargets

• RunCommandTargets array
  • items RunCommandTarget

ScheduleExpression

• ScheduleExpression string

StatementId

• StatementId string

String

• String string

Target

• Target object: Targets are the resources to be invoked when a rule is triggered. Target types include EC2 instances, AWS Lambda functions, Amazon Kinesis streams, Amazon ECS tasks, AWS Step Functions state machines, Run Command, and built-in targets.
  • Arn required TargetArn
  • EcsParameters EcsParameters
  • Id required TargetId
  • Input TargetInput
  • InputPath TargetInputPath
  • InputTransformer InputTransformer
  • KinesisParameters KinesisParameters
  • RoleArn RoleArn
  • RunCommandParameters RunCommandParameters

TargetArn

• TargetArn string

TargetId

• TargetId string

TargetIdList

• TargetIdList array
  • items TargetId

TargetInput

• TargetInput string

TargetInputPath

• TargetInputPath string

TargetList

• TargetList array
  • items Target

TargetPartitionKeyPath

• TargetPartitionKeyPath string

TestEventPatternRequest

• TestEventPatternRequest object
  • Event required String
  • EventPattern required EventPattern

TestEventPatternResponse

• TestEventPatternResponse object
  • Result Boolean

TransformerInput

• TransformerInput string

TransformerPaths

• TransformerPaths array
  • items object
    • key InputTransformerPathKey
    • value TargetInputPath