Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow jslibbreadcrumb arrow awsbreadcrumb arrow EventBridgeClientbreadcrumb arrow putEvents
Open source

putEvents

EventBridgeClient.putEvents sends custom events to Amazon EventBridge so that they can be matched to rules.

Parameters

ParameterTypeDescription
inputPutEventsInputAn array of objects representing events to be submitted.

PutEventsInput

ParameterTypeDescription
EntriesEventBridgeEntry[]An array of objects representing events to be submitted.
EndpointIdstring (optional)The ID of the target to receive the event.

EventBridgeEntry

ParameterTypeDescription
SourcestringThe source of the event.
DetailobjectA JSON object containing event data.
DetailTypestringFree-form string used to decide what fields to expect in the event detail.
Resourcesstring[] (optional)AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.
EventBusNamestring (optional)The event bus that will receive the event. If you omit this, the default event bus is used. Only the AWS account that owns a bus can write to it.

Returns

TypeDescription
Promise<void>A Promise that fulfills when the events have been sent to Amazon EventBridge.

Example

JavaScript
JavaScript 
import {
  AWSConfig,
  EventBridgeClient,
} from 'https://jslib.k6.io/aws/0.14.0/event-bridge.js';

const awsConfig = new AWSConfig({
  region: __ENV.AWS_REGION,
  accessKeyId: __ENV.AWS_ACCESS_KEY_ID,
  secretAccessKey: __ENV.AWS_SECRET_ACCESS_KEY,
  sessionToken: __ENV.AWS_SESSION_TOKEN,
});

const eventBridge = new EventBridgeClient(awsConfig);
const eventEntry = {
  Source: 'my.source',
  Detail: {
    key: 'value',
  },
  DetailType: 'MyDetailType',
  Resources: ['resource-arn'],
};

export default async function () {
  await eventBridge.putEvents({
    Entries: [eventEntry],
  });
}