Class: AWS.EventBridge

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

    The name of the replay to cancel.

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:

    • ReplayArn — (String)

      The ARN of the replay to cancel.

    • State — (String)

      The current state of the replay.

      Possible values include:
      • "STARTING"
      • "RUNNING"
      • "CANCELLING"
      • "COMPLETED"
      • "CANCELLED"
      • "FAILED"
    • StateReason — (String)

      The reason that the replay is in the current state.

Returns:

• (AWS.Request) —

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

var params = {
  ConnectionArn: 'STRING_VALUE', /* required */
  HttpMethod: POST | GET | HEAD | OPTIONS | PUT | PATCH | DELETE, /* required */
  InvocationEndpoint: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  InvocationRateLimitPerSecond: 'NUMBER_VALUE'
};
eventbridge.createApiDestination(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 for the API destination to create.

  • Description — (String)

    A description for the API destination to create.

  • ConnectionArn — (String)

    The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

  • InvocationEndpoint — (String)

    The URL to the HTTP invocation endpoint for the API destination.

  • HttpMethod — (String)

    The method to use for the request to the HTTP invocation endpoint.

    Possible values include:
    • "POST"
    • "GET"
    • "HEAD"
    • "OPTIONS"
    • "PUT"
    • "PATCH"
    • "DELETE"
  • InvocationRateLimitPerSecond — (Integer)

    The maximum number of requests per second to send to the HTTP invocation endpoint.

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:

    • ApiDestinationArn — (String)

      The ARN of the API destination that was created by the request.

    • ApiDestinationState — (String)

      The state of the API destination that was created by the request.

      Possible values include:
      • "ACTIVE"
      • "INACTIVE"
    • CreationTime — (Date)

      A time stamp indicating the time that the API destination was created.

    • LastModifiedTime — (Date)

      A time stamp indicating the time that the API destination was last modified.

Returns:

• (AWS.Request) —

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

var params = {
  ArchiveName: 'STRING_VALUE', /* required */
  EventSourceArn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  EventPattern: 'STRING_VALUE',
  RetentionDays: 'NUMBER_VALUE'
};
eventbridge.createArchive(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: {}) —
  • ArchiveName — (String)

    The name for the archive to create.

  • EventSourceArn — (String)

    The ARN of the event bus that sends events to the archive.

  • Description — (String)

    A description for the archive.

  • EventPattern — (String)

    An event pattern to use to filter events sent to the archive.

  • RetentionDays — (Integer)

    The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

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:

    • ArchiveArn — (String)

      The ARN of the archive that was created.

    • State — (String)

      The state of the archive that was created.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
      • "CREATING"
      • "UPDATING"
      • "CREATE_FAILED"
      • "UPDATE_FAILED"
    • StateReason — (String)

      The reason that the archive is in the state.

    • CreationTime — (Date)

      The time at which the archive was created.

Returns:

• (AWS.Request) —

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

var params = {
  AuthParameters: { /* required */
    ApiKeyAuthParameters: {
      ApiKeyName: 'STRING_VALUE', /* required */
      ApiKeyValue: 'STRING_VALUE' /* required */
    },
    BasicAuthParameters: {
      Password: 'STRING_VALUE', /* required */
      Username: 'STRING_VALUE' /* required */
    },
    InvocationHttpParameters: {
      BodyParameters: [
        {
          IsValueSecret: true || false,
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ],
      HeaderParameters: [
        {
          IsValueSecret: true || false,
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ],
      QueryStringParameters: [
        {
          IsValueSecret: true || false,
          Key: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    OAuthParameters: {
      AuthorizationEndpoint: 'STRING_VALUE', /* required */
      ClientParameters: { /* required */
        ClientID: 'STRING_VALUE', /* required */
        ClientSecret: 'STRING_VALUE' /* required */
      },
      HttpMethod: GET | POST | PUT, /* required */
      OAuthHttpParameters: {
        BodyParameters: [
          {
            IsValueSecret: true || false,
            Key: 'STRING_VALUE',
            Value: 'STRING_VALUE'
          },
          /* more items */
        ],
        HeaderParameters: [
          {
            IsValueSecret: true || false,
            Key: 'STRING_VALUE',
            Value: 'STRING_VALUE'
          },
          /* more items */
        ],
        QueryStringParameters: [
          {
            IsValueSecret: true || false,
            Key: 'STRING_VALUE',
            Value: 'STRING_VALUE'
          },
          /* more items */
        ]
      }
    }
  },
  AuthorizationType: BASIC | OAUTH_CLIENT_CREDENTIALS | API_KEY, /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE'
};
eventbridge.createConnection(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 for the connection to create.

  • Description — (String)

    A description for the connection to create.

  • AuthorizationType — (String)

    The type of authorization to use for the connection.

    Note: OAUTH tokens are refreshed when a 401 or 407 response is returned.
    Possible values include:
    • "BASIC"
    • "OAUTH_CLIENT_CREDENTIALS"
    • "API_KEY"
  • AuthParameters — (map)

    A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.

    • BasicAuthParameters — (map)

      A CreateConnectionBasicAuthRequestParameters object that contains the Basic authorization parameters to use for the connection.

      • Username — required — (String)

        The user name to use for Basic authorization.

      • Password — required — (String)

        The password associated with the user name to use for Basic authorization.

    • OAuthParameters — (map)

      A CreateConnectionOAuthRequestParameters object that contains the OAuth authorization parameters to use for the connection.

      • ClientParameters — required — (map)

        A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth authorization.

        • ClientID — required — (String)

          The client ID to use for OAuth authorization for the connection.

        • ClientSecret — required — (String)

          The client secret associated with the client ID to use for OAuth authorization for the connection.

      • AuthorizationEndpoint — required — (String)

        The URL to the authorization endpoint when OAuth is specified as the authorization type.

      • HttpMethod — required — (String)

        The method to use for the authorization request.

        Possible values include:
        • "GET"
        • "POST"
        • "PUT"
      • OAuthHttpParameters — (map)

        A ConnectionHttpParameters object that contains details about the additional parameters to use for the connection.

        • HeaderParameters — (Array<map>)

          Contains additional header parameters for the connection.

          • Key — (String)

            The key for the parameter.

          • Value — (String)

            The value associated with the key.

          • IsValueSecret — (Boolean)

            Specified whether the value is a secret.

        • QueryStringParameters — (Array<map>)

          Contains additional query string parameters for the connection.

          • Key — (String)

            The key for a query string parameter.

          • Value — (String)

            The value associated with the key for the query string parameter.

          • IsValueSecret — (Boolean)

            Specifies whether the value is secret.

        • BodyParameters — (Array<map>)

          Contains additional body string parameters for the connection.

          • Key — (String)

            The key for the parameter.

          • Value — (String)

            The value associated with the key.

          • IsValueSecret — (Boolean)

            Specified whether the value is secret.

    • ApiKeyAuthParameters — (map)

      A CreateConnectionApiKeyAuthRequestParameters object that contains the API key authorization parameters to use for the connection.

      • ApiKeyName — required — (String)

        The name of the API key to use for authorization.

      • ApiKeyValue — required — (String)

        The value for the API key to use for authorization.

    • InvocationHttpParameters — (map)

      A ConnectionHttpParameters object that contains the API key authorization parameters to use for the connection. Note that if you include additional parameters for the target of a rule via HttpParameters, including query strings, the parameters added for the connection take precedence.

      • HeaderParameters — (Array<map>)

        Contains additional header parameters for the connection.

        • Key — (String)

          The key for the parameter.

        • Value — (String)

          The value associated with the key.

        • IsValueSecret — (Boolean)

          Specified whether the value is a secret.

      • QueryStringParameters — (Array<map>)

        Contains additional query string parameters for the connection.

        • Key — (String)

          The key for a query string parameter.

        • Value — (String)

          The value associated with the key for the query string parameter.

        • IsValueSecret — (Boolean)

          Specifies whether the value is secret.

      • BodyParameters — (Array<map>)

        Contains additional body string parameters for the connection.

        • Key — (String)

          The key for the parameter.

        • Value — (String)

          The value associated with the key.

        • IsValueSecret — (Boolean)

          Specified whether the value is secret.

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:

    • ConnectionArn — (String)

      The ARN of the connection that was created by the request.

    • ConnectionState — (String)

      The state of the connection that was created by the request.

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "AUTHORIZED"
      • "DEAUTHORIZED"
      • "AUTHORIZING"
      • "DEAUTHORIZING"
    • CreationTime — (Date)

      A time stamp for the time that the connection was created.

    • LastModifiedTime — (Date)

      A time stamp for the time that the connection was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  EventBuses: [ /* required */
    {
      EventBusArn: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Name: 'STRING_VALUE', /* required */
  RoutingConfig: { /* required */
    FailoverConfig: { /* required */
      Primary: { /* required */
        HealthCheck: 'STRING_VALUE' /* required */
      },
      Secondary: { /* required */
        Route: 'STRING_VALUE' /* required */
      }
    }
  },
  Description: 'STRING_VALUE',
  ReplicationConfig: {
    State: ENABLED | DISABLED
  },
  RoleArn: 'STRING_VALUE'
};
eventbridge.createEndpoint(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 global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".

  • Description — (String)

    A description of the global endpoint.

  • RoutingConfig — (map)

    Configure the routing policy, including the health check and secondary Region..

    • FailoverConfig — required — (map)

      The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

      • Primary — required — (map)

        The main Region of the endpoint.

        • HealthCheck — required — (String)

          The ARN of the health check used by the endpoint to determine whether failover is triggered.

      • Secondary — required — (map)

        The Region that events are routed to when failover is triggered or event replication is enabled.

        • Route — required — (String)

          Defines the secondary Region.

  • ReplicationConfig — (map)

    Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

    • State — (String)

      The state of event replication.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
  • EventBuses — (Array<map>)

    Define the event buses used.

    The names of the event buses must be identical in each Region.

    • EventBusArn — required — (String)

      The ARN of the event bus the endpoint is associated with.

  • RoleArn — (String)

    The ARN of the role used for replication.

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 endpoint that was created by this request.

    • Arn — (String)

      The ARN of the endpoint that was created by this request.

    • RoutingConfig — (map)

      The routing configuration defined by this request.

      • FailoverConfig — required — (map)

        The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

        • Primary — required — (map)

          The main Region of the endpoint.

          • HealthCheck — required — (String)

            The ARN of the health check used by the endpoint to determine whether failover is triggered.

        • Secondary — required — (map)

          The Region that events are routed to when failover is triggered or event replication is enabled.

          • Route — required — (String)

            Defines the secondary Region.

    • ReplicationConfig — (map)

      Whether event replication was enabled or disabled by this request.

      • State — (String)

        The state of event replication.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
    • EventBuses — (Array<map>)

      The event buses used by this request.

      • EventBusArn — required — (String)

        The ARN of the event bus the endpoint is associated with.

    • RoleArn — (String)

      The ARN of the role used by event replication for this request.

    • State — (String)

      The state of the endpoint that was created by this request.

      Possible values include:
      • "ACTIVE"
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "CREATE_FAILED"
      • "UPDATE_FAILED"
      • "DELETE_FAILED"

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE', /* required */
  DeadLetterConfig: {
    Arn: 'STRING_VALUE'
  },
  Description: 'STRING_VALUE',
  EventSourceName: 'STRING_VALUE',
  KmsKeyIdentifier: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
eventbridge.createEventBus(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 new event bus.

    Custom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.

    You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.

  • EventSourceName — (String)

    If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.

  • Description — (String)

    The event bus description.

  • KmsKeyIdentifier — (String)

    The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

    If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt events on the event bus.

    For more information, see Managing keys in the Key Management Service Developer Guide.

    Note: Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

    • You call CreateArchive on an event bus set to use a customer managed key for encryption.
    • You call CreateDiscoverer on an event bus set to use a customer managed key for encryption.
    • You call UpdatedEventBus to set a customer managed key on an event bus with an archives or schema discovery enabled.

    To enable archives or schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
  • DeadLetterConfig — (map)

    Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

    For more information, see Event retry policy and using dead-letter queues in the EventBridge User Guide.

    • Arn — (String)

      The ARN of the SQS queue specified as the target for the dead-letter queue.

  • Tags — (Array<map>)

    Tags to associate with the event bus.

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

    • EventBusArn — (String)

      The ARN of the new event bus.

    • Description — (String)

      The event bus description.

    • KmsKeyIdentifier — (String)

      The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.

      For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

    • DeadLetterConfig — (map)

      Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

      For more information, see Event retry policy and using dead-letter queues in the EventBridge User Guide.

      • Arn — (String)

        The ARN of the SQS queue specified as the target for the dead-letter queue.

Returns:

• (AWS.Request) —

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

var params = {
  Account: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
eventbridge.createPartnerEventSource(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 partner event source. This name must be unique and must be in the format partner_name/event_namespace/event_name . The Amazon Web Services account that wants to use this partner event source must create a partner event bus with a name that matches the name of the partner event source.

  • Account — (String)

    The Amazon Web Services account ID that is permitted to create a matching partner event bus for this partner event source.

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:

    • EventSourceArn — (String)

      The ARN of the partner event source.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE' /* required */
};
eventbridge.deactivateEventSource(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 partner event source to deactivate.

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.

var params = {
  Name: 'STRING_VALUE' /* required */
};
eventbridge.deauthorizeConnection(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 connection to remove authorization from.

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:

    • ConnectionArn — (String)

      The ARN of the connection that authorization was removed from.

    • ConnectionState — (String)

      The state of the connection.

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "AUTHORIZED"
      • "DEAUTHORIZED"
      • "AUTHORIZING"
      • "DEAUTHORIZING"
    • CreationTime — (Date)

      A time stamp for the time that the connection was created.

    • LastModifiedTime — (Date)

      A time stamp for the time that the connection was last updated.

    • LastAuthorizedTime — (Date)

      A time stamp for the time that the connection was last authorized.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE' /* required */
};
eventbridge.deleteApiDestination(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 destination to delete.

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.

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

    The name of the archive to delete.

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.

var params = {
  Name: 'STRING_VALUE' /* required */
};
eventbridge.deleteConnection(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 connection to delete.

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:

    • ConnectionArn — (String)

      The ARN of the connection that was deleted.

    • ConnectionState — (String)

      The state of the connection before it was deleted.

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "AUTHORIZED"
      • "DEAUTHORIZED"
      • "AUTHORIZING"
      • "DEAUTHORIZING"
    • CreationTime — (Date)

      A time stamp for the time that the connection was created.

    • LastModifiedTime — (Date)

      A time stamp for the time that the connection was last modified before it was deleted.

    • LastAuthorizedTime — (Date)

      A time stamp for the time that the connection was last authorized before it wa deleted.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE' /* required */
};
eventbridge.deleteEndpoint(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 endpoint you want to delete. For example, "Name":"us-east-2-custom_bus_A-endpoint"..

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.

var params = {
  Name: 'STRING_VALUE' /* required */
};
eventbridge.deleteEventBus(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 event bus to delete.

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.

var params = {
  Account: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
eventbridge.deletePartnerEventSource(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 event source to delete.

  • Account — (String)

    The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.

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.

var params = {
  Name: 'STRING_VALUE', /* required */
  EventBusName: 'STRING_VALUE',
  Force: true || false
};
eventbridge.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.

  • EventBusName — (String)

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

  • Force — (Boolean)

    If this is a managed rule, created by an Amazon Web Services 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.

var params = {
  Name: 'STRING_VALUE' /* required */
};
eventbridge.describeApiDestination(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 API destination to retrieve.

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:

    • ApiDestinationArn — (String)

      The ARN of the API destination retrieved.

    • Name — (String)

      The name of the API destination retrieved.

    • Description — (String)

      The description for the API destination retrieved.

    • ApiDestinationState — (String)

      The state of the API destination retrieved.

      Possible values include:
      • "ACTIVE"
      • "INACTIVE"
    • ConnectionArn — (String)

      The ARN of the connection specified for the API destination retrieved.

    • InvocationEndpoint — (String)

      The URL to use to connect to the HTTP endpoint.

    • HttpMethod — (String)

      The method to use to connect to the HTTP endpoint.

      Possible values include:
      • "POST"
      • "GET"
      • "HEAD"
      • "OPTIONS"
      • "PUT"
      • "PATCH"
      • "DELETE"
    • InvocationRateLimitPerSecond — (Integer)

      The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.

    • CreationTime — (Date)

      A time stamp for the time that the API destination was created.

    • LastModifiedTime — (Date)

      A time stamp for the time that the API destination was last modified.

Returns:

• (AWS.Request) —

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

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

    The name of the archive to retrieve.

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:

    • ArchiveArn — (String)

      The ARN of the archive.

    • ArchiveName — (String)

      The name of the archive.

    • EventSourceArn — (String)

      The ARN of the event source associated with the archive.

    • Description — (String)

      The description of the archive.

    • EventPattern — (String)

      The event pattern used to filter events sent to the archive.

    • State — (String)

      The state of the archive.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
      • "CREATING"
      • "UPDATING"
      • "CREATE_FAILED"
      • "UPDATE_FAILED"
    • StateReason — (String)

      The reason that the archive is in the state.

    • RetentionDays — (Integer)

      The number of days to retain events for in the archive.

    • SizeBytes — (Integer)

      The size of the archive in bytes.

    • EventCount — (Integer)

      The number of events in the archive.

    • CreationTime — (Date)

      The time at which the archive was created.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE' /* required */
};
eventbridge.describeConnection(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 connection to retrieve.

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:

    • ConnectionArn — (String)

      The ARN of the connection retrieved.

    • Name — (String)

      The name of the connection retrieved.

    • Description — (String)

      The description for the connection retrieved.

    • ConnectionState — (String)

      The state of the connection retrieved.

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "AUTHORIZED"
      • "DEAUTHORIZED"
      • "AUTHORIZING"
      • "DEAUTHORIZING"
    • StateReason — (String)

      The reason that the connection is in the current connection state.

    • AuthorizationType — (String)

      The type of authorization specified for the connection.

      Possible values include:
      • "BASIC"
      • "OAUTH_CLIENT_CREDENTIALS"
      • "API_KEY"
    • SecretArn — (String)

      The ARN of the secret created from the authorization parameters specified for the connection.

    • AuthParameters — (map)

      The parameters to use for authorization for the connection.

      • BasicAuthParameters — (map)

        The authorization parameters for Basic authorization.

        • Username — (String)

          The user name to use for Basic authorization.

      • OAuthParameters — (map)

        The OAuth parameters to use for authorization.

        • ClientParameters — (map)

          A ConnectionOAuthClientResponseParameters object that contains details about the client parameters returned when OAuth is specified as the authorization type.

          • ClientID — (String)

            The client ID associated with the response to the connection request.

        • AuthorizationEndpoint — (String)

          The URL to the HTTP endpoint that authorized the request.

        • HttpMethod — (String)

          The method used to connect to the HTTP endpoint.

          Possible values include:
          • "GET"
          • "POST"
          • "PUT"
        • OAuthHttpParameters — (map)

          The additional HTTP parameters used for the OAuth authorization request.

          • HeaderParameters — (Array<map>)

            Contains additional header parameters for the connection.

            • Key — (String)

              The key for the parameter.

            • Value — (String)

              The value associated with the key.

            • IsValueSecret — (Boolean)

              Specified whether the value is a secret.

          • QueryStringParameters — (Array<map>)

            Contains additional query string parameters for the connection.

            • Key — (String)

              The key for a query string parameter.

            • Value — (String)

              The value associated with the key for the query string parameter.

            • IsValueSecret — (Boolean)

              Specifies whether the value is secret.

          • BodyParameters — (Array<map>)

            Contains additional body string parameters for the connection.

            • Key — (String)

              The key for the parameter.

            • Value — (String)

              The value associated with the key.

            • IsValueSecret — (Boolean)

              Specified whether the value is secret.

      • ApiKeyAuthParameters — (map)

        The API Key parameters to use for authorization.

        • ApiKeyName — (String)

          The name of the header to use for the APIKeyValue used for authorization.

      • InvocationHttpParameters — (map)

        Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

        • HeaderParameters — (Array<map>)

          Contains additional header parameters for the connection.

          • Key — (String)

            The key for the parameter.

          • Value — (String)

            The value associated with the key.

          • IsValueSecret — (Boolean)

            Specified whether the value is a secret.

        • QueryStringParameters — (Array<map>)

          Contains additional query string parameters for the connection.

          • Key — (String)

            The key for a query string parameter.

          • Value — (String)

            The value associated with the key for the query string parameter.

          • IsValueSecret — (Boolean)

            Specifies whether the value is secret.

        • BodyParameters — (Array<map>)

          Contains additional body string parameters for the connection.

          • Key — (String)

            The key for the parameter.

          • Value — (String)

            The value associated with the key.

          • IsValueSecret — (Boolean)

            Specified whether the value is secret.

    • CreationTime — (Date)

      A time stamp for the time that the connection was created.

    • LastModifiedTime — (Date)

      A time stamp for the time that the connection was last modified.

    • LastAuthorizedTime — (Date)

      A time stamp for the time that the connection was last authorized.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE', /* required */
  HomeRegion: 'STRING_VALUE'
};
eventbridge.describeEndpoint(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 endpoint you want to get information about. For example, "Name":"us-east-2-custom_bus_A-endpoint".

  • HomeRegion — (String)

    The primary Region of the endpoint you want to get information about. For example "HomeRegion": "us-east-1".

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 endpoint you asked for information about.

    • Description — (String)

      The description of the endpoint you asked for information about.

    • Arn — (String)

      The ARN of the endpoint you asked for information about.

    • RoutingConfig — (map)

      The routing configuration of the endpoint you asked for information about.

      • FailoverConfig — required — (map)

        The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

        • Primary — required — (map)

          The main Region of the endpoint.

          • HealthCheck — required — (String)

            The ARN of the health check used by the endpoint to determine whether failover is triggered.

        • Secondary — required — (map)

          The Region that events are routed to when failover is triggered or event replication is enabled.

          • Route — required — (String)

            Defines the secondary Region.

    • ReplicationConfig — (map)

      Whether replication is enabled or disabled for the endpoint you asked for information about.

      • State — (String)

        The state of event replication.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
    • EventBuses — (Array<map>)

      The event buses being used by the endpoint you asked for information about.

      • EventBusArn — required — (String)

        The ARN of the event bus the endpoint is associated with.

    • RoleArn — (String)

      The ARN of the role used by the endpoint you asked for information about.

    • EndpointId — (String)

      The ID of the endpoint you asked for information about.

    • EndpointUrl — (String)

      The URL of the endpoint you asked for information about.

    • State — (String)

      The current state of the endpoint you asked for information about.

      Possible values include:
      • "ACTIVE"
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "CREATE_FAILED"
      • "UPDATE_FAILED"
      • "DELETE_FAILED"
    • StateReason — (String)

      The reason the endpoint you asked for information about is in its current state.

    • CreationTime — (Date)

      The time the endpoint you asked for information about was created.

    • LastModifiedTime — (Date)

      The last time the endpoint you asked for information about was modified.

Returns:

• (AWS.Request) —

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

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

    The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.

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.

    • Description — (String)

      The event bus description.

    • KmsKeyIdentifier — (String)

      The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.

      For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

    • DeadLetterConfig — (map)

      Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

      For more information, see Event retry policy and using dead-letter queues in the EventBridge User Guide.

      • Arn — (String)

        The ARN of the SQS queue specified as the target for the dead-letter queue.

    • Policy — (String)

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

    • CreationTime — (Date)

      The time the event bus was created.

    • LastModifiedTime — (Date)

      The time the event bus was last modified.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE' /* required */
};
eventbridge.describeEventSource(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 partner event source to display the details of.

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:

    • Arn — (String)

      The ARN of the partner event source.

    • CreatedBy — (String)

      The name of the SaaS partner that created the event source.

    • CreationTime — (Date)

      The date and time that the event source was created.

    • ExpirationTime — (Date)

      The date and time that the event source will expire if you do not create a matching event bus.

    • Name — (String)

      The name of the partner event source.

    • State — (String)

      The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.

      Possible values include:
      • "PENDING"
      • "ACTIVE"
      • "DELETED"

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE' /* required */
};
eventbridge.describePartnerEventSource(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 event source to display.

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:

    • Arn — (String)

      The ARN of the event source.

    • Name — (String)

      The name of the event source.

Returns:

• (AWS.Request) —

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

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

    The name of the replay to retrieve.

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:

    • ReplayName — (String)

      The name of the replay.

    • ReplayArn — (String)

      The ARN of the replay.

    • Description — (String)

      The description of the replay.

    • State — (String)

      The current state of the replay.

      Possible values include:
      • "STARTING"
      • "RUNNING"
      • "CANCELLING"
      • "COMPLETED"
      • "CANCELLED"
      • "FAILED"
    • StateReason — (String)

      The reason that the replay is in the current state.

    • EventSourceArn — (String)

      The ARN of the archive events were replayed from.

    • Destination — (map)

      A ReplayDestination object that contains details about the replay.

      • Arn — required — (String)

        The ARN of the event bus to replay event to. You can replay events only to the event bus specified to create the archive.

      • FilterArns — (Array<String>)

        A list of ARNs for rules to replay events to.

    • EventStartTime — (Date)

      The time stamp of the first event that was last replayed from the archive.

    • EventEndTime — (Date)

      The time stamp for the last event that was replayed from the archive.

    • EventLastReplayedTime — (Date)

      The time that the event was last replayed.

    • ReplayStartTime — (Date)

      A time stamp for the time that the replay started.

    • ReplayEndTime — (Date)

      A time stamp for the time that the replay stopped.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE', /* required */
  EventBusName: 'STRING_VALUE'
};
eventbridge.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.

  • EventBusName — (String)

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

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 EventBridge 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"
      • "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS"
    • 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 Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.

    • EventBusName — (String)

      The name of the event bus associated with the rule.

    • CreatedBy — (String)

      The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

Returns:

• (AWS.Request) —

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

var params = {
  Name: 'STRING_VALUE', /* required */
  EventBusName: 'STRING_VALUE'
};
eventbridge.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.

  • EventBusName — (String)

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

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.

var params = {
  Name: 'STRING_VALUE', /* required */
  EventBusName: 'STRING_VALUE'
};
eventbridge.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.

  • EventBusName — (String)

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

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.

var params = {
  ConnectionArn: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  NamePrefix: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
eventbridge.listApiDestinations(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)

    A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.

  • ConnectionArn — (String)

    The ARN of the connection specified for the API destination.

  • NextToken — (String)

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

  • Limit — (Integer)

    The maximum number of API destinations to include in 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:

    • ApiDestinations — (Array<map>)

      An array of ApiDestination objects that include information about an API destination.

      • ApiDestinationArn — (String)

        The ARN of the API destination.

      • Name — (String)

        The name of the API destination.

      • ApiDestinationState — (String)

        The state of the API destination.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • ConnectionArn — (String)

        The ARN of the connection specified for the API destination.

      • InvocationEndpoint — (String)

        The URL to the endpoint for the API destination.

      • HttpMethod — (String)

        The method to use to connect to the HTTP endpoint.

        Possible values include:
        • "POST"
        • "GET"
        • "HEAD"
        • "OPTIONS"
        • "PUT"
        • "PATCH"
        • "DELETE"
      • InvocationRateLimitPerSecond — (Integer)

        The maximum number of invocations per second to send to the HTTP endpoint.

      • CreationTime — (Date)

        A time stamp for the time that the API destination was created.

      • LastModifiedTime — (Date)

        A time stamp for the time that the API destination was last modified.

    • NextToken — (String)

      A token you can use in a subsequent request to retrieve the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  EventSourceArn: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  NamePrefix: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  State: ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED | UPDATE_FAILED
};
eventbridge.listArchives(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)

    A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.

  • EventSourceArn — (String)

    The ARN of the event source associated with the archive.

  • State — (String)

    The state of the archive.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
    • "CREATING"
    • "UPDATING"
    • "CREATE_FAILED"
    • "UPDATE_FAILED"
  • 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:

    • Archives — (Array<map>)

      An array of Archive objects that include details about an archive.

      • ArchiveName — (String)

        The name of the archive.

      • EventSourceArn — (String)

        The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive.

      • State — (String)

        The current state of the archive.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
        • "CREATING"
        • "UPDATING"
        • "CREATE_FAILED"
        • "UPDATE_FAILED"
      • StateReason — (String)

        A description for the reason that the archive is in the current state.

      • RetentionDays — (Integer)

        The number of days to retain events in the archive before they are deleted.

      • SizeBytes — (Integer)

        The size of the archive, in bytes.

      • EventCount — (Integer)

        The number of events in the archive.

      • CreationTime — (Date)

        The time stamp for the time that the archive was created.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  ConnectionState: CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED | AUTHORIZING | DEAUTHORIZING,
  Limit: 'NUMBER_VALUE',
  NamePrefix: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
eventbridge.listConnections(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)

    A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.

  • ConnectionState — (String)

    The state of the connection.

    Possible values include:
    • "CREATING"
    • "UPDATING"
    • "DELETING"
    • "AUTHORIZED"
    • "DEAUTHORIZED"
    • "AUTHORIZING"
    • "DEAUTHORIZING"
  • NextToken — (String)

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

  • Limit — (Integer)

    The maximum number of connections 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:

    • Connections — (Array<map>)

      An array of connections objects that include details about the connections.

      • ConnectionArn — (String)

        The ARN of the connection.

      • Name — (String)

        The name of the connection.

      • ConnectionState — (String)

        The state of the connection.

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "AUTHORIZED"
        • "DEAUTHORIZED"
        • "AUTHORIZING"
        • "DEAUTHORIZING"
      • StateReason — (String)

        The reason that the connection is in the connection state.

      • AuthorizationType — (String)

        The authorization type specified for the connection.

        Note: OAUTH tokens are refreshed when a 401 or 407 response is returned.
        Possible values include:
        • "BASIC"
        • "OAUTH_CLIENT_CREDENTIALS"
        • "API_KEY"
      • CreationTime — (Date)

        A time stamp for the time that the connection was created.

      • LastModifiedTime — (Date)

        A time stamp for the time that the connection was last modified.

      • LastAuthorizedTime — (Date)

        A time stamp for the time that the connection was last authorized.

    • NextToken — (String)

      A token you can use in a subsequent request to retrieve the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  HomeRegion: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NamePrefix: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
eventbridge.listEndpoints(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)

    A value that will return a subset of the endpoints associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

  • HomeRegion — (String)

    The primary Region of the endpoints associated with this account. For example "HomeRegion": "us-east-1".

  • NextToken — (String)

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • MaxResults — (Integer)

    The maximum number of results returned by the call.

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:

    • Endpoints — (Array<map>)

      The endpoints returned by the call.

      • Name — (String)

        The name of the endpoint.

      • Description — (String)

        A description for the endpoint.

      • Arn — (String)

        The ARN of the endpoint.

      • RoutingConfig — (map)

        The routing configuration of the endpoint.

        • FailoverConfig — required — (map)

          The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

          • Primary — required — (map)

            The main Region of the endpoint.

            • HealthCheck — required — (String)

              The ARN of the health check used by the endpoint to determine whether failover is triggered.

          • Secondary — required — (map)

            The Region that events are routed to when failover is triggered or event replication is enabled.

            • Route — required — (String)

              Defines the secondary Region.

      • ReplicationConfig — (map)

        Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

        • State — (String)

          The state of event replication.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
      • EventBuses — (Array<map>)

        The event buses being used by the endpoint.

        • EventBusArn — required — (String)

          The ARN of the event bus the endpoint is associated with.

      • RoleArn — (String)

        The ARN of the role used by event replication for the endpoint.

      • EndpointId — (String)

        The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

      • EndpointUrl — (String)

        The URL of the endpoint.

      • State — (String)

        The current state of the endpoint.

        Possible values include:
        • "ACTIVE"
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "UPDATE_FAILED"
        • "DELETE_FAILED"
      • StateReason — (String)

        The reason the endpoint is in its current state.

      • CreationTime — (Date)

        The time the endpoint was created.

      • LastModifiedTime — (Date)

        The last time the endpoint was modified.

    • NextToken — (String)

      If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

• (AWS.Request) —

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

var params = {
  Limit: 'NUMBER_VALUE',
  NamePrefix: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
eventbridge.listEventBuses(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)

    Specifying this limits the results to only those event buses with names that start with the specified prefix.

  • NextToken — (String)

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

  • Limit — (Integer)

    Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

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:

    • EventBuses — (Array<map>)

      This list of event buses.

      • Name — (String)

        The name of the event bus.

      • Arn — (String)

        The ARN of the event bus.

      • Description — (String)

        The event bus description.

      • Policy — (String)

        The permissions policy of the event bus, describing which other Amazon Web Services accounts can write events to this event bus.

      • CreationTime — (Date)

        The time the event bus was created.

      • LastModifiedTime — (Date)

        The time the event bus was last modified.

    • NextToken — (String)

      A token you can use in a subsequent operation to retrieve the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  Limit: 'NUMBER_VALUE',
  NamePrefix: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
eventbridge.listEventSources(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)

    Specifying this limits the results to only those partner event sources with names that start with the specified prefix.

  • NextToken — (String)

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

  • Limit — (Integer)

    Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

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:

    • EventSources — (Array<map>)

      The list of event sources.

      • Arn — (String)

        The ARN of the event source.

      • CreatedBy — (String)

        The name of the partner that created the event source.

      • CreationTime — (Date)

        The date and time the event source was created.

      • ExpirationTime — (Date)

        The date and time that the event source will expire, if the Amazon Web Services account doesn't create a matching event bus for it.

      • Name — (String)

        The name of the event source.

      • State — (String)

        The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.

        Possible values include:
        • "PENDING"
        • "ACTIVE"
        • "DELETED"
    • NextToken — (String)

      A token you can use in a subsequent operation to retrieve the next set of results.

Returns:

• (AWS.Request) —

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

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

    The name of the partner event source to display account information about.

  • NextToken — (String)

    The token returned by a previous call to this operation. Specifying this retrieves the next set of results.

  • Limit — (Integer)

    Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

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:

    • PartnerEventSourceAccounts — (Array<map>)

      The list of partner event sources returned by the operation.

      • Account — (String)

        The Amazon Web Services account ID that the partner event source was offered to.

      • CreationTime — (Date)

        The date and time the event source was created.

      • ExpirationTime — (Date)

        The date and time that the event source will expire, if the Amazon Web Services account doesn't create a matching event bus for it.

      • State — (String)

        The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.

        Possible values include:
        • "PENDING"
        • "ACTIVE"
        • "DELETED"
    • NextToken — (String)

      A token you can use in a subsequent operation to retrieve the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  NamePrefix: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
eventbridge.listPartnerEventSources(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)

    If you specify this, the results are limited to only those partner event sources that start with the string you specify.

  • NextToken — (String)

    The token returned by a previous call to this operation. Specifying this retrieves the next set of results.

  • Limit — (Integer)

    pecifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

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:

    • PartnerEventSources — (Array<map>)

      The list of partner event sources returned by the operation.

      • Arn — (String)

        The ARN of the partner event source.

      • Name — (String)

        The name of the partner event source.

    • NextToken — (String)

      A token you can use in a subsequent operation to retrieve the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  EventSourceArn: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  NamePrefix: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  State: STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED | FAILED
};
eventbridge.listReplays(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)

    A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.

  • State — (String)

    The state of the replay.

    Possible values include:
    • "STARTING"
    • "RUNNING"
    • "CANCELLING"
    • "COMPLETED"
    • "CANCELLED"
    • "FAILED"
  • EventSourceArn — (String)

    The ARN of the archive from which the events are replayed.

  • NextToken — (String)

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

  • Limit — (Integer)

    The maximum number of replays to retrieve.

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:

    • Replays — (Array<map>)

      An array of Replay objects that contain information about the replay.

      • ReplayName — (String)

        The name of the replay.

      • EventSourceArn — (String)

        The ARN of the archive to replay event from.

      • State — (String)

        The current state of the replay.

        Possible values include:
        • "STARTING"
        • "RUNNING"
        • "CANCELLING"
        • "COMPLETED"
        • "CANCELLED"
        • "FAILED"
      • StateReason — (String)

        A description of why the replay is in the current state.

      • EventStartTime — (Date)

        A time stamp for the time to start replaying events. This is determined by the time in the event as described in Time.

      • EventEndTime — (Date)

        A time stamp for the time to start replaying events. Any event with a creation time prior to the EventEndTime specified is replayed.

      • EventLastReplayedTime — (Date)

        A time stamp for the time that the last event was replayed.

      • ReplayStartTime — (Date)

        A time stamp for the time that the replay started.

      • ReplayEndTime — (Date)

        A time stamp for the time that the replay completed.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  TargetArn: 'STRING_VALUE', /* required */
  EventBusName: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
eventbridge.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.

  • EventBusName — (String)

    The name or ARN of the event bus to list rules for. If you omit this, the default event bus is used.

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

var params = {
  EventBusName: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  NamePrefix: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
eventbridge.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.

  • EventBusName — (String)

    The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.

  • 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 EventBridge User Guide .

      • State — (String)

        The state of the rule.

        Valid values include:

        • DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

        • ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

        • ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

          Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .

          This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.

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

        The description of the rule.

      • ScheduleExpression — (String)

        The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.

      • RoleArn — (String)

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

        If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.

      • ManagedBy — (String)

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

      • EventBusName — (String)

        The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

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

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
eventbridge.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 EventBridge resource 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 resource 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.

var params = {
  Rule: 'STRING_VALUE', /* required */
  EventBusName: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
eventbridge.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.

  • EventBusName — (String)

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

  • 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 within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.

      • 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 may use JSON dot notation or 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 100 key-value pairs. You must use JSON dot notation, not bracket notation.

          The keys cannot start with "Amazon Web Services."

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

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

          • The placeholder cannot be used as an object key.

          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>\""

          }

          The InputTemplate can also be valid JSON with varibles in quotes or out, as in the following example:

          "InputTransformer":

          {

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

          "InputTemplate": '{"myInstance": <instance>,"myStatus": "<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 Fargate with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

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

          Use this structure if the Amazon 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 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.

        • CapacityProviderStrategy — (Array<map>)

          The capacity provider strategy to use for the task.

          If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

          • capacityProvider — required — (String)

            The short name of the capacity provider.

          • weight — (Integer)

            The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

          • base — (Integer)

            The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

        • EnableECSManagedTags — (Boolean)

          Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

        • EnableExecuteCommand — (Boolean)

          Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

        • PlacementConstraints — (Array<map>)

          An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).

          • type — (String)

            The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

            Possible values include:
            • "distinctInstance"
            • "memberOf"
          • expression — (String)

            A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

        • PlacementStrategy — (Array<map>)

          The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

          • type — (String)

            The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).

            Possible values include:
            • "random"
            • "spread"
            • "binpack"
          • field — (String)

            The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

        • PropagateTags — (String)

          Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

          Possible values include:
          • "TASK_DEFINITION"
        • ReferenceId — (String)

          The reference ID to use for the task.

        • Tags — (Array<map>)

          The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.

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

      • BatchParameters — (map)

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

        • JobDefinition — required — (String)

          The ARN or name of the job definition to use if the event target is an 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 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 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 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.

      • HttpParameters — (map)

        Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.

        If you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.

        • PathParameterValues — (Array<String>)

          The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").

        • HeaderParameters — (map<String>)

          The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

        • QueryStringParameters — (map<String>)

          The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

      • RedshiftDataParameters — (map)

        Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.

        If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

        • SecretManagerArn — (String)

          The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.

        • Database — required — (String)

          The name of the database. Required when authenticating using temporary credentials.

        • DbUser — (String)

          The database user name. Required when authenticating using temporary credentials.

        • Sql — (String)

          The SQL statement text to run.

        • StatementName — (String)

          The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

        • WithEvent — (Boolean)

          Indicates whether to send an event back to EventBridge after the SQL statement runs.

        • Sqls — (Array<String>)

          One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.

      • SageMakerPipelineParameters — (map)

        Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.

        If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.

        • PipelineParameterList — (Array<map>)

          List of Parameter names and values for SageMaker Model Building Pipeline execution.

          • Name — required — (String)

            Name of parameter to start execution of a SageMaker Model Building Pipeline.

          • Value — required — (String)

            Value of parameter to start execution of a SageMaker Model Building Pipeline.

      • DeadLetterConfig — (map)

        The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

        • Arn — (String)

          The ARN of the SQS queue specified as the target for the dead-letter queue.

      • RetryPolicy — (map)

        The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.

        • MaximumRetryAttempts — (Integer)

          The maximum number of retry attempts to make before the request fails. Retry attempts continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is met.

        • MaximumEventAgeInSeconds — (Integer)

          The maximum amount of time, in seconds, to continue to make retry attempts.

      • AppSyncParameters — (map)

        Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.

        • GraphQLOperation — (String)

          The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.

          For more information, see Operations in the AppSync User Guide.

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

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

      Note: Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.
    • Resources — (Array<String>)

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

    • DetailType — (String)

      Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

      Note: Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.
    • Detail — (String)

      A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested sub-objects.

      Note: Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.
    • EventBusName — (String)

      The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are used to match the event. If you omit this, the default event bus is used.

      Note: If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name (ARN) of the event bus in either the primary or secondary Region here. EventBridge then determines the corresponding event bus in the other Region based on the endpoint referenced by the EndpointId. Specifying the event bus ARN is preferred.
    • TraceHeader — (String)

      An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.

      To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.

  • EndpointId — (String)

    The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

    When using Java, you must include auth-crt on the class path.

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.

      For each record, the index of the response element is the same as the index in the request array.

      • EventId — (String)

        The ID of the event.

      • ErrorCode — (String)

        The error code that indicates why the event submission failed.

        Retryable errors include:

        • InternalFailure

          The request processing has failed because of an unknown error, exception or failure.

        • ThrottlingException

          The request was denied due to request throttling.

        Non-retryable errors include:

        • AccessDeniedException

          You do not have sufficient access to perform this action.

        • InvalidAccountIdException

          The account ID provided is not valid.

        • InvalidArgument

          A specified parameter is not valid.

        • MalformedDetail

          The JSON provided is not valid.

        • RedactionFailure

          Redacting the CloudTrail event failed.

        • NotAuthorizedForSourceException

          You do not have permissions to publish events with this source onto this event bus.

        • NotAuthorizedForDetailTypeException

          You do not have permissions to publish events with this detail type onto this event bus.

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

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 */
  ]
};
eventbridge.putPartnerEvents(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 list of events to write to the event bus.

    • Time — (Date)

      The date and time of the event.

    • Source — (String)

      The event source that is generating the entry.

      Note: Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.
    • Resources — (Array<String>)

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

    • DetailType — (String)

      A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

      Note: Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.
    • Detail — (String)

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

      Note: Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

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 events from this operation that could not be written to the partner event bus.

    • Entries — (Array<map>)

      The results for each event entry the partner submitted in this request. If the event was successfully submitted, 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.

      For each record, the index of the response element is the same as the index in the request array.

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

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

    The name of the event bus associated with the rule. If you omit this, the default event bus is used.

  • Action — (String)

    The action that you are enabling the other account to perform.

  • Principal — (String)

    The 12-digit Amazon Web Services 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.

    Note: Each StatementId must be unique.
  • 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 Amazon Web Services organization. For more information about Amazon Web Services Organizations, see What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide.

    If you specify Condition with an Amazon Web Services 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.

  • Policy — (String)

    A JSON string that describes the permission policy statement. You can include a Policy parameter in the request instead of using the StatementId, Action, Principal, or Condition parameters.