npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datafire/amazonaws_eventbridge

v5.0.0

Published

DataFire integration for Amazon EventBridge

Downloads

7

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

datafiredatafire

Keywords

Readme

@datafire/amazonaws_eventbridge

Client library for Amazon EventBridge

Installation and Usage

npm install --save @datafire/amazonaws_eventbridge
let amazonaws_eventbridge = require('@datafire/amazonaws_eventbridge').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

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

Description

Actions

ActivateEventSource

amazonaws_eventbridge.ActivateEventSource({
  "Name": null
}, context)

Input

  • input object
    • Name required

Output

Output schema unknown

CancelReplay

amazonaws_eventbridge.CancelReplay({
  "ReplayName": null
}, context)

Input

  • input object
    • ReplayName required

Output

CreateArchive

amazonaws_eventbridge.CreateArchive({
  "ArchiveName": null,
  "EventSourceArn": null
}, context)

Input

  • input object
    • ArchiveName required
    • Description
    • EventPattern
    • EventSourceArn required
    • RetentionDays

Output

CreateEventBus

amazonaws_eventbridge.CreateEventBus({
  "Name": null
}, context)

Input

  • input object
    • EventSourceName
    • Name required
    • Tags

Output

CreatePartnerEventSource

amazonaws_eventbridge.CreatePartnerEventSource({
  "Name": null,
  "Account": null
}, context)

Input

  • input object
    • Account required
    • Name required

Output

DeactivateEventSource

amazonaws_eventbridge.DeactivateEventSource({
  "Name": null
}, context)

Input

  • input object
    • Name required

Output

Output schema unknown

DeleteArchive

amazonaws_eventbridge.DeleteArchive({
  "ArchiveName": null
}, context)

Input

  • input object
    • ArchiveName required

Output

DeleteEventBus

amazonaws_eventbridge.DeleteEventBus({
  "Name": null
}, context)

Input

  • input object
    • Name required

Output

Output schema unknown

DeletePartnerEventSource

amazonaws_eventbridge.DeletePartnerEventSource({
  "Name": null,
  "Account": null
}, context)

Input

  • input object
    • Account required
    • Name required

Output

Output schema unknown

DeleteRule

amazonaws_eventbridge.DeleteRule({
  "Name": null
}, context)

Input

  • input object
    • EventBusName
    • Force
    • Name required

Output

Output schema unknown

DescribeArchive

amazonaws_eventbridge.DescribeArchive({
  "ArchiveName": null
}, context)

Input

  • input object
    • ArchiveName required

Output

DescribeEventBus

amazonaws_eventbridge.DescribeEventBus({}, context)

Input

  • input object
    • Name

Output

DescribeEventSource

amazonaws_eventbridge.DescribeEventSource({
  "Name": null
}, context)

Input

  • input object
    • Name required

Output

DescribePartnerEventSource

amazonaws_eventbridge.DescribePartnerEventSource({
  "Name": null
}, context)

Input

  • input object
    • Name required

Output

DescribeReplay

amazonaws_eventbridge.DescribeReplay({
  "ReplayName": null
}, context)

Input

  • input object
    • ReplayName required

Output

DescribeRule

amazonaws_eventbridge.DescribeRule({
  "Name": null
}, context)

Input

  • input object
    • EventBusName
    • Name required

Output

DisableRule

amazonaws_eventbridge.DisableRule({
  "Name": null
}, context)

Input

  • input object
    • EventBusName
    • Name required

Output

Output schema unknown

EnableRule

amazonaws_eventbridge.EnableRule({
  "Name": null
}, context)

Input

  • input object
    • EventBusName
    • Name required

Output

Output schema unknown

ListArchives

amazonaws_eventbridge.ListArchives({}, context)

Input

  • input object
    • EventSourceArn
    • Limit
    • NamePrefix
    • NextToken
    • State

Output

ListEventBuses

amazonaws_eventbridge.ListEventBuses({}, context)

Input

  • input object
    • Limit
    • NamePrefix
    • NextToken

Output

ListEventSources

amazonaws_eventbridge.ListEventSources({}, context)

Input

  • input object
    • Limit
    • NamePrefix
    • NextToken

Output

ListPartnerEventSourceAccounts

amazonaws_eventbridge.ListPartnerEventSourceAccounts({
  "EventSourceName": null
}, context)

Input

  • input object
    • EventSourceName required
    • Limit
    • NextToken

Output

ListPartnerEventSources

amazonaws_eventbridge.ListPartnerEventSources({
  "NamePrefix": null
}, context)

Input

  • input object
    • Limit
    • NamePrefix required
    • NextToken

Output

ListReplays

amazonaws_eventbridge.ListReplays({}, context)

Input

  • input object
    • EventSourceArn
    • Limit
    • NamePrefix
    • NextToken
    • State

Output

ListRuleNamesByTarget

amazonaws_eventbridge.ListRuleNamesByTarget({
  "TargetArn": null
}, context)

Input

  • input object
    • EventBusName
    • Limit
    • NextToken
    • TargetArn required

Output

ListRules

amazonaws_eventbridge.ListRules({}, context)

Input

  • input object
    • EventBusName
    • Limit
    • NamePrefix
    • NextToken

Output

ListTagsForResource

amazonaws_eventbridge.ListTagsForResource({
  "ResourceARN": null
}, context)

Input

  • input object
    • ResourceARN required

Output

ListTargetsByRule

amazonaws_eventbridge.ListTargetsByRule({
  "Rule": null
}, context)

Input

  • input object
    • EventBusName
    • Limit
    • NextToken
    • Rule required

Output

PutEvents

amazonaws_eventbridge.PutEvents({
  "Entries": null
}, context)

Input

Output

PutPartnerEvents

amazonaws_eventbridge.PutPartnerEvents({
  "Entries": null
}, context)

Input

Output

PutPermission

amazonaws_eventbridge.PutPermission({}, context)

Input

  • input object
    • Action
    • Condition
      • Key required
      • Type required
      • Value required
    • EventBusName
    • Policy
    • Principal
    • StatementId

Output

Output schema unknown

PutRule

amazonaws_eventbridge.PutRule({
  "Name": null
}, context)

Input

  • input object
    • Description
    • EventBusName
    • EventPattern
    • Name required
    • RoleArn
    • ScheduleExpression
    • State
    • Tags

Output

PutTargets

amazonaws_eventbridge.PutTargets({
  "Rule": null,
  "Targets": null
}, context)

Input

  • input object
    • EventBusName
    • Rule required
    • Targets required

Output

RemovePermission

amazonaws_eventbridge.RemovePermission({}, context)

Input

  • input object
    • EventBusName
    • RemoveAllPermissions
    • StatementId

Output

Output schema unknown

RemoveTargets

amazonaws_eventbridge.RemoveTargets({
  "Rule": null,
  "Ids": null
}, context)

Input

  • input object
    • EventBusName
    • Force
    • Ids required
    • Rule required

Output

StartReplay

amazonaws_eventbridge.StartReplay({
  "ReplayName": null,
  "EventSourceArn": null,
  "EventStartTime": null,
  "EventEndTime": null,
  "Destination": null
}, context)

Input

  • input object
    • Description
    • Destination required
      • Arn required
      • FilterArns
    • EventEndTime required
    • EventSourceArn required
    • EventStartTime required
    • ReplayName required

Output

TagResource

amazonaws_eventbridge.TagResource({
  "ResourceARN": null,
  "Tags": null
}, context)

Input

  • input object
    • ResourceARN required
    • Tags required

Output

TestEventPattern

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

Input

  • input object
    • Event required
    • EventPattern required

Output

UntagResource

amazonaws_eventbridge.UntagResource({
  "ResourceARN": null,
  "TagKeys": null
}, context)

Input

  • input object
    • ResourceARN required
    • TagKeys required

Output

UpdateArchive

amazonaws_eventbridge.UpdateArchive({
  "ArchiveName": null
}, context)

Input

  • input object
    • ArchiveName required
    • Description
    • EventPattern
    • RetentionDays

Output

Definitions

AccountId

  • AccountId string

Action

  • Action string

ActivateEventSourceRequest

  • ActivateEventSourceRequest object
    • Name required

Archive

  • Archive object: An Archive object that contains details about an archive.
    • ArchiveName
    • CreationTime
    • EventCount
    • EventSourceArn
    • RetentionDays
    • SizeBytes
    • State
    • StateReason

ArchiveArn

  • ArchiveArn string

ArchiveDescription

  • ArchiveDescription string

ArchiveName

  • ArchiveName string

ArchiveResponseList

  • ArchiveResponseList array

ArchiveState

  • ArchiveState string (values: ENABLED, DISABLED, CREATING, UPDATING, CREATE_FAILED, UPDATE_FAILED)

ArchiveStateReason

  • ArchiveStateReason string

Arn

  • Arn string

AssignPublicIp

  • AssignPublicIp string (values: ENABLED, DISABLED)

AwsVpcConfiguration

  • AwsVpcConfiguration object: This structure specifies 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.
    • AssignPublicIp
    • SecurityGroups
    • Subnets required

BatchArrayProperties

  • BatchArrayProperties object: 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

BatchParameters

  • BatchParameters object: The custom parameters to be used when the target is an AWS Batch job.
    • ArrayProperties
      • Size
    • JobDefinition required
    • JobName required
    • RetryStrategy
      • Attempts

BatchRetryStrategy

  • BatchRetryStrategy object: The retry strategy to use for failed jobs, if the target is an AWS Batch job. If you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
    • Attempts

Boolean

  • Boolean boolean

CancelReplayRequest

  • CancelReplayRequest object
    • ReplayName required

CancelReplayResponse

  • CancelReplayResponse object
    • ReplayArn
    • State
    • StateReason

ConcurrentModificationException

Condition

  • Condition object: A JSON string which you can use to limit the event bus permissions you are granting to only accounts that fulfill the condition. Currently, the only supported condition is membership in a certain AWS organization. The string must contain Type, Key, and Value fields. The Value field specifies the ID of the AWS organization. Following is an example value for Condition: '{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}'
    • Key required
    • Type required
    • Value required

CreateArchiveRequest

  • CreateArchiveRequest object
    • ArchiveName required
    • Description
    • EventPattern
    • EventSourceArn required
    • RetentionDays

CreateArchiveResponse

  • CreateArchiveResponse object
    • ArchiveArn
    • CreationTime
    • State
    • StateReason

CreateEventBusRequest

  • CreateEventBusRequest object
    • EventSourceName
    • Name required
    • Tags

CreateEventBusResponse

  • CreateEventBusResponse object
    • EventBusArn

CreatePartnerEventSourceRequest

  • CreatePartnerEventSourceRequest object
    • Account required
    • Name required

CreatePartnerEventSourceResponse

  • CreatePartnerEventSourceResponse object
    • EventSourceArn

CreatedBy

  • CreatedBy string

Database

  • Database string

DbUser

  • DbUser string

DeactivateEventSourceRequest

  • DeactivateEventSourceRequest object
    • Name required

DeadLetterConfig

  • DeadLetterConfig object: A DeadLetterConfig object that contains information about a dead-letter queue configuration.
    • Arn

DeleteArchiveRequest

  • DeleteArchiveRequest object
    • ArchiveName required

DeleteArchiveResponse

  • DeleteArchiveResponse object

DeleteEventBusRequest

  • DeleteEventBusRequest object
    • Name required

DeletePartnerEventSourceRequest

  • DeletePartnerEventSourceRequest object
    • Account required
    • Name required

DeleteRuleRequest

  • DeleteRuleRequest object
    • EventBusName
    • Force
    • Name required

DescribeArchiveRequest

  • DescribeArchiveRequest object
    • ArchiveName required

DescribeArchiveResponse

  • DescribeArchiveResponse object
    • ArchiveArn
    • ArchiveName
    • CreationTime
    • Description
    • EventCount
    • EventPattern
    • EventSourceArn
    • RetentionDays
    • SizeBytes
    • State
    • StateReason

DescribeEventBusRequest

  • DescribeEventBusRequest object
    • Name

DescribeEventBusResponse

  • DescribeEventBusResponse object
    • Arn
    • Name
    • Policy

DescribeEventSourceRequest

  • DescribeEventSourceRequest object
    • Name required

DescribeEventSourceResponse

  • DescribeEventSourceResponse object
    • Arn
    • CreatedBy
    • CreationTime
    • ExpirationTime
    • Name
    • State

DescribePartnerEventSourceRequest

  • DescribePartnerEventSourceRequest object
    • Name required

DescribePartnerEventSourceResponse

  • DescribePartnerEventSourceResponse object
    • Arn
    • Name

DescribeReplayRequest

  • DescribeReplayRequest object
    • ReplayName required

DescribeReplayResponse

  • DescribeReplayResponse object
    • Description
    • Destination
      • Arn required
      • FilterArns
    • EventEndTime
    • EventLastReplayedTime
    • EventSourceArn
    • EventStartTime
    • ReplayArn
    • ReplayEndTime
    • ReplayName
    • ReplayStartTime
    • State
    • StateReason

DescribeRuleRequest

  • DescribeRuleRequest object
    • EventBusName
    • Name required

DescribeRuleResponse

  • DescribeRuleResponse object
    • Arn
    • CreatedBy
    • Description
    • EventBusName
    • EventPattern
    • ManagedBy
    • Name
    • RoleArn
    • ScheduleExpression
    • State

DisableRuleRequest

  • DisableRuleRequest object
    • EventBusName
    • Name required

EcsParameters

  • EcsParameters object: The custom parameters to be used when the target is an Amazon ECS task.
    • Group
    • LaunchType
    • NetworkConfiguration
      • awsvpcConfiguration
        • AssignPublicIp
        • SecurityGroups
        • Subnets required
    • PlatformVersion
    • TaskCount
    • TaskDefinitionArn required

EnableRuleRequest

  • EnableRuleRequest object
    • EventBusName
    • Name required

ErrorCode

  • ErrorCode string

ErrorMessage

  • ErrorMessage string

EventBus

  • EventBus object: An event bus receives events from a source and routes them to rules associated with that event bus. Your account's default event bus receives rules from AWS services. A custom event bus can receive rules from AWS services as well as your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.
    • Arn
    • Name
    • Policy

EventBusList

EventBusName

  • EventBusName string

EventBusNameOrArn

  • EventBusNameOrArn string

EventId

  • EventId string

EventPattern

  • EventPattern string

EventResource

  • EventResource string

EventResourceList

EventSource

  • EventSource object: A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that AWS account can receive events from the partner's applications or services.
    • Arn
    • CreatedBy
    • CreationTime
    • ExpirationTime
    • Name
    • State

EventSourceList

EventSourceName

  • EventSourceName string

EventSourceNamePrefix

  • EventSourceNamePrefix string

EventSourceState

  • EventSourceState string (values: PENDING, ACTIVE, DELETED)

EventTime

  • EventTime string

HeaderKey

  • HeaderKey string

HeaderParametersMap

  • HeaderParametersMap object

HeaderValue

  • HeaderValue string

HttpParameters

  • HttpParameters object: These are custom parameter to be used when the target is an API Gateway REST APIs.
    • HeaderParameters
    • PathParameterValues
    • QueryStringParameters

IllegalStatusException

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
    • InputTemplate required

InputTransformerPathKey

  • InputTransformerPathKey string

Integer

  • Integer integer

InternalException

InvalidEventPatternException

InvalidStateException

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 data 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

LaunchType

  • LaunchType string (values: EC2, FARGATE)

LimitExceededException

LimitMax100

  • LimitMax100 integer

LimitMin1

  • LimitMin1 integer

ListArchivesRequest

  • ListArchivesRequest object
    • EventSourceArn
    • Limit
    • NamePrefix
    • NextToken
    • State

ListArchivesResponse

  • ListArchivesResponse object

ListEventBusesRequest

  • ListEventBusesRequest object
    • Limit
    • NamePrefix
    • NextToken

ListEventBusesResponse

  • ListEventBusesResponse object

ListEventSourcesRequest

  • ListEventSourcesRequest object
    • Limit
    • NamePrefix
    • NextToken

ListEventSourcesResponse

  • ListEventSourcesResponse object

ListPartnerEventSourceAccountsRequest

  • ListPartnerEventSourceAccountsRequest object
    • EventSourceName required
    • Limit
    • NextToken

ListPartnerEventSourceAccountsResponse

ListPartnerEventSourcesRequest

  • ListPartnerEventSourcesRequest object
    • Limit
    • NamePrefix required
    • NextToken

ListPartnerEventSourcesResponse

  • ListPartnerEventSourcesResponse object

ListReplaysRequest

  • ListReplaysRequest object
    • EventSourceArn
    • Limit
    • NamePrefix
    • NextToken
    • State

ListReplaysResponse

  • ListReplaysResponse object

ListRuleNamesByTargetRequest

  • ListRuleNamesByTargetRequest object
    • EventBusName
    • Limit
    • NextToken
    • TargetArn required

ListRuleNamesByTargetResponse

  • ListRuleNamesByTargetResponse object

ListRulesRequest

  • ListRulesRequest object
    • EventBusName
    • Limit
    • NamePrefix
    • NextToken

ListRulesResponse

  • ListRulesResponse object
    • NextToken
    • Rules

ListTagsForResourceRequest

  • ListTagsForResourceRequest object
    • ResourceARN required

ListTagsForResourceResponse

  • ListTagsForResourceResponse object

ListTargetsByRuleRequest

  • ListTargetsByRuleRequest object
    • EventBusName
    • Limit
    • NextToken
    • Rule required

ListTargetsByRuleResponse

  • ListTargetsByRuleResponse object

Long

  • Long integer

ManagedBy

  • ManagedBy string

ManagedRuleException

MaximumEventAgeInSeconds

  • MaximumEventAgeInSeconds integer

MaximumRetryAttempts

  • MaximumRetryAttempts integer

MessageGroupId

  • MessageGroupId string

NetworkConfiguration

  • NetworkConfiguration object: This structure specifies the network configuration for an ECS task.
    • awsvpcConfiguration
      • AssignPublicIp
      • SecurityGroups
      • Subnets required

NextToken

  • NextToken string

NonPartnerEventBusName

  • NonPartnerEventBusName string

NonPartnerEventBusNameOrArn

  • NonPartnerEventBusNameOrArn string

OperationDisabledException

PartnerEventSource

  • PartnerEventSource object: A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that AWS account can receive events from the partner's applications or services.
    • Arn
    • Name

PartnerEventSourceAccount

  • PartnerEventSourceAccount object: The AWS account that a partner event source has been offered to.
    • Account
    • CreationTime
    • ExpirationTime
    • State

PartnerEventSourceAccountList

PartnerEventSourceList

PartnerEventSourceNamePrefix

  • PartnerEventSourceNamePrefix string

PathParameter

  • PathParameter string

PathParameterList

PolicyLengthExceededException

Principal

  • Principal string

PutEventsRequest

PutEventsRequestEntry

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

PutEventsRequestEntryList

PutEventsResponse

PutEventsResultEntry

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

PutEventsResultEntryList

PutPartnerEventsRequest

PutPartnerEventsRequestEntry

  • PutPartnerEventsRequestEntry object: The details about an event generated by an SaaS partner.

PutPartnerEventsRequestEntryList

PutPartnerEventsResponse

PutPartnerEventsResultEntry

  • PutPartnerEventsResultEntry object: Represents an event that a partner tried to generate, but failed.
    • ErrorCode
    • ErrorMessage
    • EventId

PutPartnerEventsResultEntryList

PutPermissionRequest

  • PutPermissionRequest object
    • Action
    • Condition
      • Key required
      • Type required
      • Value required
    • EventBusName
    • Policy
    • Principal
    • StatementId

PutRuleRequest

  • PutRuleRequest object
    • Description
    • EventBusName
    • EventPattern
    • Name required
    • RoleArn
    • ScheduleExpression
    • State
    • Tags

PutRuleResponse

  • PutRuleResponse object
    • RuleArn

PutTargetsRequest

  • PutTargetsRequest object
    • EventBusName
    • Rule required
    • Targets required

PutTargetsResponse

PutTargetsResultEntry

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

PutTargetsResultEntryList

QueryStringKey

  • QueryStringKey string

QueryStringParametersMap

  • QueryStringParametersMap object

QueryStringValue

  • QueryStringValue string

RedshiftDataParameters

  • RedshiftDataParameters object: These are custom parameters to be used when the target is a Redshift cluster to invoke the Redshift Data API ExecuteStatement based on EventBridge events.
    • Database required
    • DbUser
    • SecretManagerArn
    • Sql required
    • StatementName
    • WithEvent

RedshiftSecretManagerArn

  • RedshiftSecretManagerArn string

RemovePermissionRequest

  • RemovePermissionRequest object
    • EventBusName
    • RemoveAllPermissions
    • StatementId

RemoveTargetsRequest

  • RemoveTargetsRequest object
    • EventBusName
    • Force
    • Ids required
    • Rule required

RemoveTargetsResponse

RemoveTargetsResultEntry

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

RemoveTargetsResultEntryList

Replay

  • Replay object: A Replay object that contains details about a replay.
    • EventEndTime
    • EventLastReplayedTime
    • EventSourceArn
    • EventStartTime
    • ReplayEndTime
    • ReplayName
    • ReplayStartTime
    • State
    • StateReason

ReplayArn

  • ReplayArn string

ReplayDescription

  • ReplayDescription string

ReplayDestination

  • ReplayDestination object: A ReplayDestination object that contains details about a replay.
    • Arn required
    • FilterArns

ReplayDestinationFilters

  • ReplayDestinationFilters array

ReplayList

ReplayName

  • ReplayName string

ReplayState

  • ReplayState string (values: STARTING, RUNNING, CANCELLING, COMPLETED, CANCELLED, FAILED)

ReplayStateReason

  • ReplayStateReason string

ResourceAlreadyExistsException

ResourceArn

  • ResourceArn string

ResourceNotFoundException

RetentionDays

  • RetentionDays integer

RetryPolicy

  • RetryPolicy object: A RetryPolicy object that includes information about the retry policy settings.
    • MaximumEventAgeInSeconds
    • MaximumRetryAttempts

RoleArn

  • RoleArn string

Rule

  • Rule object: Contains information about a rule in Amazon EventBridge.
    • Arn
    • Description
    • EventBusName
    • EventPattern
    • ManagedBy
    • Name
    • RoleArn
    • ScheduleExpression
    • State

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

Sql

  • Sql string

SqsParameters

  • SqsParameters object: This structure includes the custom parameter to be used when the target is an SQS FIFO queue.
    • MessageGroupId

StartReplayRequest

  • StartReplayRequest object
    • Description
    • Destination required
      • Arn required
      • FilterArns
    • EventEndTime required
    • EventSourceArn required
    • EventStartTime required
    • ReplayName required

StartReplayResponse

  • StartReplayResponse object
    • ReplayArn
    • ReplayStartTime
    • State
    • StateReason

StatementId

  • StatementId string

StatementName

  • StatementName string

String

  • String string

StringList

Tag

  • Tag object: A key-value pair associated with an AWS resource. In EventBridge, rules and event buses support tagging.
    • Key required
    • Value required

TagKey

  • TagKey string

TagKeyList

TagList

  • TagList array

TagResourceRequest

  • TagResourceRequest object
    • ResourceARN required
    • Tags required

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

Target

  • Target object: Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets. 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 EventBridge User Guide.
    • Arn required
    • BatchParameters
      • ArrayProperties
        • Size
      • JobDefinition required
      • JobName required
      • RetryStrategy
        • Attempts
    • DeadLetterConfig
      • Arn
    • EcsParameters
      • Group
      • LaunchType
      • NetworkConfiguration
        • awsvpcConfiguration
          • AssignPublicIp
          • SecurityGroups
          • Subnets required
      • PlatformVersion
      • TaskCount
      • TaskDefinitionArn required
    • HttpParameters
      • HeaderParameters
      • PathParameterValues
      • QueryStringParameters
    • Id required
    • Input
    • InputPath
    • InputTransformer
      • InputPathsMap
      • InputTemplate required
    • KinesisParameters
      • PartitionKeyPath required
    • RedshiftDataParameters
      • Database required
      • DbUser
      • SecretManagerArn
      • Sql required
      • StatementName
      • WithEvent
    • RetryPolicy
      • MaximumEventAgeInSeconds
      • MaximumRetryAttempts
    • RoleArn
    • RunCommandParameters
    • SqsParameters
      • MessageGroupId

TargetArn

  • TargetArn string

TargetId

  • TargetId string

TargetIdList

TargetInput

  • TargetInput string

TargetInputPath

  • TargetInputPath string

TargetList

TargetPartitionKeyPath

  • TargetPartitionKeyPath string

TestEventPatternRequest

  • TestEventPatternRequest object
    • Event required
    • EventPattern required

TestEventPatternResponse

  • TestEventPatternResponse object
    • Result

Timestamp

  • Timestamp string

TransformerInput

  • TransformerInput string

TransformerPaths

  • TransformerPaths object

UntagResourceRequest

  • UntagResourceRequest object
    • ResourceARN required
    • TagKeys required

UntagResourceResponse

  • UntagResourceResponse object

UpdateArchiveRequest

  • UpdateArchiveRequest object
    • ArchiveName required
    • Description
    • EventPattern
    • RetentionDays

UpdateArchiveResponse

  • UpdateArchiveResponse object
    • ArchiveArn
    • CreationTime
    • State
    • StateReason