Class: Aws::EventBridge::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-eventbridge/client.rb

Overview

An API client for EventBridge. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::EventBridge::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::EventBridge::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::EventBridge::EndpointParameters`

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



441
442
443
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 441

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



4063
4064
4065
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 4063

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



4066
4067
4068
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 4066

def errors_module
  Errors
end

Instance Method Details

#activate_event_source(params = {}) ⇒ Struct

Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.

Examples:

Request syntax with placeholder values


resp = client.activate_event_source({
  name: "EventSourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the partner event source to activate.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



466
467
468
469
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 466

def activate_event_source(params = {}, options = {})
  req = build_request(:activate_event_source, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 4036

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::EventBridge')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-eventbridge'
  context[:gem_version] = '1.66.0'
  Seahorse::Client::Request.new(handlers, context)
end

#cancel_replay(params = {}) ⇒ Types::CancelReplayResponse

Cancels the specified replay.

Examples:

Request syntax with placeholder values


resp = client.cancel_replay({
  replay_name: "ReplayName", # required
})

Response structure


resp.replay_arn #=> String
resp.state #=> String, one of "STARTING", "RUNNING", "CANCELLING", "COMPLETED", "CANCELLED", "FAILED"
resp.state_reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :replay_name (required, String) —

    The name of the replay to cancel.

Returns:

See Also:



498
499
500
501
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 498

def cancel_replay(params = {}, options = {})
  req = build_request(:cancel_replay, params)
  req.send_request(options)
end

#create_api_destination(params = {}) ⇒ Types::CreateApiDestinationResponse

Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.

API destinations do not support private destinations, such as interface VPC endpoints.

For more information, see [API destinations] in the *EventBridge User Guide*.

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html

Examples:

Request syntax with placeholder values


resp = client.create_api_destination({
  name: "ApiDestinationName", # required
  description: "ApiDestinationDescription",
  connection_arn: "ConnectionArn", # required
  invocation_endpoint: "HttpsEndpoint", # required
  http_method: "POST", # required, accepts POST, GET, HEAD, OPTIONS, PUT, PATCH, DELETE
  invocation_rate_limit_per_second: 1,
})

Response structure


resp.api_destination_arn #=> String
resp.api_destination_state #=> String, one of "ACTIVE", "INACTIVE"
resp.creation_time #=> Time
resp.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name for the API destination to create.

  • :description (String) —

    A description for the API destination to create.

  • :connection_arn (required, String) —

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

  • :invocation_endpoint (required, String) —

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

  • :http_method (required, String) —

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

  • :invocation_rate_limit_per_second (Integer) —

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

Returns:

See Also:



566
567
568
569
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 566

def create_api_destination(params = {}, options = {})
  req = build_request(:create_api_destination, params)
  req.send_request(options)
end

#create_archive(params = {}) ⇒ Types::CreateArchiveResponse

Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.

<note markdown=“1”> 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*.

</note>

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html

Examples:

Request syntax with placeholder values


resp = client.create_archive({
  archive_name: "ArchiveName", # required
  event_source_arn: "Arn", # required
  description: "ArchiveDescription",
  event_pattern: "EventPattern",
  retention_days: 1,
})

Response structure


resp.archive_arn #=> String
resp.state #=> String, one of "ENABLED", "DISABLED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
resp.state_reason #=> String
resp.creation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :archive_name (required, String) —

    The name for the archive to create.

  • :event_source_arn (required, String) —

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

  • :description (String) —

    A description for the archive.

  • :event_pattern (String) —

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

  • :retention_days (Integer) —

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

Returns:

See Also:



645
646
647
648
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 645

def create_archive(params = {}, options = {})
  req = build_request(:create_archive, params)
  req.send_request(options)
end

#create_connection(params = {}) ⇒ Types::CreateConnectionResponse

Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.

Examples:

Request syntax with placeholder values


resp = client.create_connection({
  name: "ConnectionName", # required
  description: "ConnectionDescription",
  authorization_type: "BASIC", # required, accepts BASIC, OAUTH_CLIENT_CREDENTIALS, API_KEY
  auth_parameters: { # required
    basic_auth_parameters: {
      username: "AuthHeaderParameters", # required
      password: "AuthHeaderParametersSensitive", # required
    },
    o_auth_parameters: {
      client_parameters: { # required
        client_id: "AuthHeaderParameters", # required
        client_secret: "AuthHeaderParametersSensitive", # required
      },
      authorization_endpoint: "HttpsEndpoint", # required
      http_method: "GET", # required, accepts GET, POST, PUT
      o_auth_http_parameters: {
        header_parameters: [
          {
            key: "HeaderKey",
            value: "HeaderValueSensitive",
            is_value_secret: false,
          },
        ],
        query_string_parameters: [
          {
            key: "QueryStringKey",
            value: "QueryStringValueSensitive",
            is_value_secret: false,
          },
        ],
        body_parameters: [
          {
            key: "String",
            value: "SensitiveString",
            is_value_secret: false,
          },
        ],
      },
    },
    api_key_auth_parameters: {
      api_key_name: "AuthHeaderParameters", # required
      api_key_value: "AuthHeaderParametersSensitive", # required
    },
    invocation_http_parameters: {
      header_parameters: [
        {
          key: "HeaderKey",
          value: "HeaderValueSensitive",
          is_value_secret: false,
        },
      ],
      query_string_parameters: [
        {
          key: "QueryStringKey",
          value: "QueryStringValueSensitive",
          is_value_secret: false,
        },
      ],
      body_parameters: [
        {
          key: "String",
          value: "SensitiveString",
          is_value_secret: false,
        },
      ],
    },
  },
})

Response structure


resp.connection_arn #=> String
resp.connection_state #=> String, one of "CREATING", "UPDATING", "DELETING", "AUTHORIZED", "DEAUTHORIZED", "AUTHORIZING", "DEAUTHORIZING"
resp.creation_time #=> Time
resp.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name for the connection to create.

  • :description (String) —

    A description for the connection to create.

  • :authorization_type (required, String) —

    The type of authorization to use for the connection.

    <note markdown=“1”> OAUTH tokens are refreshed when a 401 or 407 response is returned.

    </note>
  • :auth_parameters (required, Types::CreateConnectionAuthRequestParameters) —

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

Returns:

See Also:



761
762
763
764
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 761

def create_connection(params = {}, options = {})
  req = build_request(:create_connection, params)
  req.send_request(options)
end

#create_endpoint(params = {}) ⇒ Types::CreateEndpointResponse

Creates a global endpoint. Global endpoints improve your application’s availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an “unhealthy” state is encountered and events will be routed back to the primary Region when the health check reports a “healthy” state.

Examples:

Request syntax with placeholder values


resp = client.create_endpoint({
  name: "EndpointName", # required
  description: "EndpointDescription",
  routing_config: { # required
    failover_config: { # required
      primary: { # required
        health_check: "HealthCheck", # required
      },
      secondary: { # required
        route: "Route", # required
      },
    },
  },
  replication_config: {
    state: "ENABLED", # accepts ENABLED, DISABLED
  },
  event_buses: [ # required
    {
      event_bus_arn: "NonPartnerEventBusArn", # required
    },
  ],
  role_arn: "IamRoleArn",
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.routing_config.failover_config.primary.health_check #=> String
resp.routing_config.failover_config.secondary.route #=> String
resp.replication_config.state #=> String, one of "ENABLED", "DISABLED"
resp.event_buses #=> Array
resp.event_buses[0].event_bus_arn #=> String
resp.role_arn #=> String
resp.state #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, 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.

  • :routing_config (required, Types::RoutingConfig) —

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

  • :replication_config (Types::ReplicationConfig) —

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

  • :event_buses (required, Array<Types::EndpointEventBus>) —

    Define the event buses used.

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

  • :role_arn (String) —

    The ARN of the role used for replication.

Returns:

See Also:



851
852
853
854
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 851

def create_endpoint(params = {}, options = {})
  req = build_request(:create_endpoint, params)
  req.send_request(options)
end

#create_event_bus(params = {}) ⇒ Types::CreateEventBusResponse

Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.

Examples:

Request syntax with placeholder values


resp = client.create_event_bus({
  name: "EventBusName", # required
  event_source_name: "EventSourceName",
  description: "EventBusDescription",
  kms_key_identifier: "KmsKeyIdentifier",
  dead_letter_config: {
    arn: "ResourceArn",
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.event_bus_arn #=> String
resp.description #=> String
resp.kms_key_identifier #=> String
resp.dead_letter_config.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, 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.

  • :event_source_name (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.

  • :kms_key_identifier (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 markdown=“1”> 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*.

    </note>

    [1]: docs.aws.amazon.com/kms/latest/developerguide/getting-started.html [2]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html

  • :dead_letter_config (Types::DeadLetterConfig) —

    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](eventbridge/latest/userguide/eb-rule-dlq.html) in the *EventBridge User Guide*.

  • :tags (Array<Types::Tag>) —

    Tags to associate with the event bus.

Returns:

See Also:



963
964
965
966
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 963

def create_event_bus(params = {}, options = {})
  req = build_request(:create_event_bus, params)
  req.send_request(options)
end

#create_partner_event_source(params = {}) ⇒ Types::CreatePartnerEventSourceResponse

Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers.

Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services account that wants to receive those event types.

A partner event source creates events based on resources within the SaaS partner’s service or application.

An Amazon Web Services account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using Amazon Web Services Events rules and targets.

Partner event source names follow this format:

‘ partner_name/event_namespace/event_name `

  • partner_name is determined during partner registration, and identifies the partner to Amazon Web Services customers.

  • event_namespace is determined by the partner, and is a way for the partner to categorize their events.

  • event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system.

    The event_name must be unique across all Amazon Web Services customers. This is because the event source is a shared resource between the partner and customer accounts, and each partner event source unique in the partner account.

The combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events.

Examples:

Request syntax with placeholder values


resp = client.create_partner_event_source({
  name: "EventSourceName", # required
  account: "AccountId", # required
})

Response structure


resp.event_source_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, 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 (required, String) —

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

Returns:

See Also:



1037
1038
1039
1040
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1037

def create_partner_event_source(params = {}, options = {})
  req = build_request(:create_partner_event_source, params)
  req.send_request(options)
end

#deactivate_event_source(params = {}) ⇒ Struct

You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted.

When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it is deleted.

To activate a deactivated partner event source, use [ActivateEventSource].

[1]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_ActivateEventSource.html

Examples:

Request syntax with placeholder values


resp = client.deactivate_event_source({
  name: "EventSourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the partner event source to deactivate.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1072
1073
1074
1075
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1072

def deactivate_event_source(params = {}, options = {})
  req = build_request(:deactivate_event_source, params)
  req.send_request(options)
end

#deauthorize_connection(params = {}) ⇒ Types::DeauthorizeConnectionResponse

Removes all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a new connection.

Examples:

Request syntax with placeholder values


resp = client.deauthorize_connection({
  name: "ConnectionName", # required
})

Response structure


resp.connection_arn #=> String
resp.connection_state #=> String, one of "CREATING", "UPDATING", "DELETING", "AUTHORIZED", "DEAUTHORIZED", "AUTHORIZING", "DEAUTHORIZING"
resp.creation_time #=> Time
resp.last_modified_time #=> Time
resp.last_authorized_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the connection to remove authorization from.

Returns:

See Also:



1110
1111
1112
1113
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1110

def deauthorize_connection(params = {}, options = {})
  req = build_request(:deauthorize_connection, params)
  req.send_request(options)
end

#delete_api_destination(params = {}) ⇒ Struct

Deletes the specified API destination.

Examples:

Request syntax with placeholder values


resp = client.delete_api_destination({
  name: "ApiDestinationName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the destination to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1132
1133
1134
1135
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1132

def delete_api_destination(params = {}, options = {})
  req = build_request(:delete_api_destination, params)
  req.send_request(options)
end

#delete_archive(params = {}) ⇒ Struct

Deletes the specified archive.

Examples:

Request syntax with placeholder values


resp = client.delete_archive({
  archive_name: "ArchiveName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :archive_name (required, String) —

    The name of the archive to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1154
1155
1156
1157
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1154

def delete_archive(params = {}, options = {})
  req = build_request(:delete_archive, params)
  req.send_request(options)
end

#delete_connection(params = {}) ⇒ Types::DeleteConnectionResponse

Deletes a connection.

Examples:

Request syntax with placeholder values


resp = client.delete_connection({
  name: "ConnectionName", # required
})

Response structure


resp.connection_arn #=> String
resp.connection_state #=> String, one of "CREATING", "UPDATING", "DELETING", "AUTHORIZED", "DEAUTHORIZED", "AUTHORIZING", "DEAUTHORIZING"
resp.creation_time #=> Time
resp.last_modified_time #=> Time
resp.last_authorized_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the connection to delete.

Returns:

See Also:



1190
1191
1192
1193
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1190

def delete_connection(params = {}, options = {})
  req = build_request(:delete_connection, params)
  req.send_request(options)
end

#delete_endpoint(params = {}) ⇒ Struct

Delete an existing global endpoint. For more information about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication] in the Amazon EventBridge User Guide .

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html

Examples:

Request syntax with placeholder values


resp = client.delete_endpoint({
  name: "EndpointName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the endpoint you want to delete. For example, ‘“Name”:“us-east-2-custom_bus_A-endpoint”`..

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1220
1221
1222
1223
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1220

def delete_endpoint(params = {}, options = {})
  req = build_request(:delete_endpoint, params)
  req.send_request(options)
end

#delete_event_bus(params = {}) ⇒ Struct

Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can’t delete your account’s default event bus.

Examples:

Request syntax with placeholder values


resp = client.delete_event_bus({
  name: "EventBusName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the event bus to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1244
1245
1246
1247
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1244

def delete_event_bus(params = {}, options = {})
  req = build_request(:delete_event_bus, params)
  req.send_request(options)
end

#delete_partner_event_source(params = {}) ⇒ Struct

This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers.

When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED.

Examples:

Request syntax with placeholder values


resp = client.delete_partner_event_source({
  name: "EventSourceName", # required
  account: "AccountId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the event source to delete.

  • :account (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1276
1277
1278
1279
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1276

def delete_partner_event_source(params = {}, options = {})
  req = build_request(:delete_partner_event_source, params)
  req.send_request(options)
end

#delete_rule(params = {}) ⇒ Struct

Deletes the specified rule.

Before you can delete the rule, you must remove all targets, using [RemoveTargets].

When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.

If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ‘ResourceNotFoundException` is returned.

Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services services to support functionality in those services. You can delete these rules using the ‘Force` option, but you should do so only if you are sure the other service is not still using that rule.

[1]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html

Examples:

Request syntax with placeholder values


resp = client.delete_rule({
  name: "RuleName", # required
  event_bus_name: "EventBusNameOrArn",
  force: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the rule.

  • :event_bus_name (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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1332
1333
1334
1335
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1332

def delete_rule(params = {}, options = {})
  req = build_request(:delete_rule, params)
  req.send_request(options)
end

#describe_api_destination(params = {}) ⇒ Types::DescribeApiDestinationResponse

Retrieves details about an API destination.

Examples:

Request syntax with placeholder values


resp = client.describe_api_destination({
  name: "ApiDestinationName", # required
})

Response structure


resp.api_destination_arn #=> String
resp.name #=> String
resp.description #=> String
resp.api_destination_state #=> String, one of "ACTIVE", "INACTIVE"
resp.connection_arn #=> String
resp.invocation_endpoint #=> String
resp.http_method #=> String, one of "POST", "GET", "HEAD", "OPTIONS", "PUT", "PATCH", "DELETE"
resp.invocation_rate_limit_per_second #=> Integer
resp.creation_time #=> Time
resp.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the API destination to retrieve.

Returns:

See Also:



1378
1379
1380
1381
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1378

def describe_api_destination(params = {}, options = {})
  req = build_request(:describe_api_destination, params)
  req.send_request(options)
end

#describe_archive(params = {}) ⇒ Types::DescribeArchiveResponse

Retrieves details about an archive.

Examples:

Request syntax with placeholder values


resp = client.describe_archive({
  archive_name: "ArchiveName", # required
})

Response structure


resp.archive_arn #=> String
resp.archive_name #=> String
resp.event_source_arn #=> String
resp.description #=> String
resp.event_pattern #=> String
resp.state #=> String, one of "ENABLED", "DISABLED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
resp.state_reason #=> String
resp.retention_days #=> Integer
resp.size_bytes #=> Integer
resp.event_count #=> Integer
resp.creation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :archive_name (required, String) —

    The name of the archive to retrieve.

Returns:

See Also:



1426
1427
1428
1429
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1426

def describe_archive(params = {}, options = {})
  req = build_request(:describe_archive, params)
  req.send_request(options)
end

#describe_connection(params = {}) ⇒ Types::DescribeConnectionResponse

Retrieves details about a connection.

Examples:

Request syntax with placeholder values


resp = client.describe_connection({
  name: "ConnectionName", # required
})

Response structure


resp.connection_arn #=> String
resp.name #=> String
resp.description #=> String
resp.connection_state #=> String, one of "CREATING", "UPDATING", "DELETING", "AUTHORIZED", "DEAUTHORIZED", "AUTHORIZING", "DEAUTHORIZING"
resp.state_reason #=> String
resp.authorization_type #=> String, one of "BASIC", "OAUTH_CLIENT_CREDENTIALS", "API_KEY"
resp.secret_arn #=> String
resp.auth_parameters.basic_auth_parameters.username #=> String
resp.auth_parameters.o_auth_parameters.client_parameters.client_id #=> String
resp.auth_parameters.o_auth_parameters.authorization_endpoint #=> String
resp.auth_parameters.o_auth_parameters.http_method #=> String, one of "GET", "POST", "PUT"
resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.header_parameters #=> Array
resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.header_parameters[0].key #=> String
resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.header_parameters[0].value #=> String
resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.header_parameters[0].is_value_secret #=> Boolean
resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.query_string_parameters #=> Array
resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.query_string_parameters[0].key #=> String
resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.query_string_parameters[0].value #=> String
resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.query_string_parameters[0].is_value_secret #=> Boolean
resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.body_parameters #=> Array
resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.body_parameters[0].key #=> String
resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.body_parameters[0].value #=> String
resp.auth_parameters.o_auth_parameters.o_auth_http_parameters.body_parameters[0].is_value_secret #=> Boolean
resp.auth_parameters.api_key_auth_parameters.api_key_name #=> String
resp.auth_parameters.invocation_http_parameters.header_parameters #=> Array
resp.auth_parameters.invocation_http_parameters.header_parameters[0].key #=> String
resp.auth_parameters.invocation_http_parameters.header_parameters[0].value #=> String
resp.auth_parameters.invocation_http_parameters.header_parameters[0].is_value_secret #=> Boolean
resp.auth_parameters.invocation_http_parameters.query_string_parameters #=> Array
resp.auth_parameters.invocation_http_parameters.query_string_parameters[0].key #=> String
resp.auth_parameters.invocation_http_parameters.query_string_parameters[0].value #=> String
resp.auth_parameters.invocation_http_parameters.query_string_parameters[0].is_value_secret #=> Boolean
resp.auth_parameters.invocation_http_parameters.body_parameters #=> Array
resp.auth_parameters.invocation_http_parameters.body_parameters[0].key #=> String
resp.auth_parameters.invocation_http_parameters.body_parameters[0].value #=> String
resp.auth_parameters.invocation_http_parameters.body_parameters[0].is_value_secret #=> Boolean
resp.creation_time #=> Time
resp.last_modified_time #=> Time
resp.last_authorized_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the connection to retrieve.

Returns:

See Also:



1502
1503
1504
1505
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1502

def describe_connection(params = {}, options = {})
  req = build_request(:describe_connection, params)
  req.send_request(options)
end

#describe_endpoint(params = {}) ⇒ Types::DescribeEndpointResponse

Get the information about an existing global endpoint. For more information about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication] in the Amazon EventBridge User Guide .

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html

Examples:

Request syntax with placeholder values


resp = client.describe_endpoint({
  name: "EndpointName", # required
  home_region: "HomeRegion",
})

Response structure


resp.name #=> String
resp.description #=> String
resp.arn #=> String
resp.routing_config.failover_config.primary.health_check #=> String
resp.routing_config.failover_config.secondary.route #=> String
resp.replication_config.state #=> String, one of "ENABLED", "DISABLED"
resp.event_buses #=> Array
resp.event_buses[0].event_bus_arn #=> String
resp.role_arn #=> String
resp.endpoint_id #=> String
resp.endpoint_url #=> String
resp.state #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.state_reason #=> String
resp.creation_time #=> Time
resp.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the endpoint you want to get information about. For example, ‘“Name”:“us-east-2-custom_bus_A-endpoint”`.

  • :home_region (String) —

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

Returns:

See Also:



1569
1570
1571
1572
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1569

def describe_endpoint(params = {}, options = {})
  req = build_request(:describe_endpoint, params)
  req.send_request(options)
end

#describe_event_bus(params = {}) ⇒ Types::DescribeEventBusResponse

Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.

To enable your account to receive events from other accounts on its default event bus, use [PutPermission].

For more information about partner event buses, see [CreateEventBus].

[1]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html [2]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html

Examples:

Request syntax with placeholder values


resp = client.describe_event_bus({
  name: "EventBusNameOrArn",
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.description #=> String
resp.kms_key_identifier #=> String
resp.dead_letter_config.arn #=> String
resp.policy #=> String
resp.creation_time #=> Time
resp.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (String) —

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

Returns:

See Also:



1627
1628
1629
1630
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1627

def describe_event_bus(params = {}, options = {})
  req = build_request(:describe_event_bus, params)
  req.send_request(options)
end

#describe_event_source(params = {}) ⇒ Types::DescribeEventSourceResponse

This operation lists details about a partner event source that is shared with your account.

Examples:

Request syntax with placeholder values


resp = client.describe_event_source({
  name: "EventSourceName", # required
})

Response structure


resp.arn #=> String
resp.created_by #=> String
resp.creation_time #=> Time
resp.expiration_time #=> Time
resp.name #=> String
resp.state #=> String, one of "PENDING", "ACTIVE", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the partner event source to display the details of.

Returns:

See Also:



1666
1667
1668
1669
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1666

def describe_event_source(params = {}, options = {})
  req = build_request(:describe_event_source, params)
  req.send_request(options)
end

#describe_partner_event_source(params = {}) ⇒ Types::DescribePartnerEventSourceResponse

An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use

DescribeEventSource][1

to see details about a partner event source

that is shared with them.

[1]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html

Examples:

Request syntax with placeholder values


resp = client.describe_partner_event_source({
  name: "EventSourceName", # required
})

Response structure


resp.arn #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the event source to display.

Returns:

See Also:



1704
1705
1706
1707
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1704

def describe_partner_event_source(params = {}, options = {})
  req = build_request(:describe_partner_event_source, params)
  req.send_request(options)
end

#describe_replay(params = {}) ⇒ Types::DescribeReplayResponse

Retrieves details about a replay. Use ‘DescribeReplay` to determine the progress of a running replay. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you use `StartReplay` and specify an `EventStartTime` and an `EventEndTime` that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use `DescribeReplay` to determine the progress of a replay. The value returned for `EventLastReplayedTime` indicates the time within the specified time range associated with the last event replayed.

Examples:

Request syntax with placeholder values


resp = client.describe_replay({
  replay_name: "ReplayName", # required
})

Response structure


resp.replay_name #=> String
resp.replay_arn #=> String
resp.description #=> String
resp.state #=> String, one of "STARTING", "RUNNING", "CANCELLING", "COMPLETED", "CANCELLED", "FAILED"
resp.state_reason #=> String
resp.event_source_arn #=> String
resp.destination.arn #=> String
resp.destination.filter_arns #=> Array
resp.destination.filter_arns[0] #=> String
resp.event_start_time #=> Time
resp.event_end_time #=> Time
resp.event_last_replayed_time #=> Time
resp.replay_start_time #=> Time
resp.replay_end_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :replay_name (required, String) —

    The name of the replay to retrieve.

Returns:

See Also:



1765
1766
1767
1768
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1765

def describe_replay(params = {}, options = {})
  req = build_request(:describe_replay, params)
  req.send_request(options)
end

#describe_rule(params = {}) ⇒ Types::DescribeRuleResponse

Describes the specified rule.

DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use [ListTargetsByRule].

[1]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html

Examples:

Request syntax with placeholder values


resp = client.describe_rule({
  name: "RuleName", # required
  event_bus_name: "EventBusNameOrArn",
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.event_pattern #=> String
resp.schedule_expression #=> String
resp.state #=> String, one of "ENABLED", "DISABLED", "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS"
resp.description #=> String
resp.role_arn #=> String
resp.managed_by #=> String
resp.event_bus_name #=> String
resp.created_by #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the rule.

  • :event_bus_name (String) —

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

Returns:

See Also:



1823
1824
1825
1826
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1823

def describe_rule(params = {}, options = {})
  req = build_request(:describe_rule, params)
  req.send_request(options)
end

#disable_rule(params = {}) ⇒ Struct

Disables the specified rule. A disabled rule won’t match any events, and won’t self-trigger if it has a schedule expression.

When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect.

Examples:

Request syntax with placeholder values


resp = client.disable_rule({
  name: "RuleName", # required
  event_bus_name: "EventBusNameOrArn",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the rule.

  • :event_bus_name (String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1855
1856
1857
1858
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1855

def disable_rule(params = {}, options = {})
  req = build_request(:disable_rule, params)
  req.send_request(options)
end

#enable_rule(params = {}) ⇒ Struct

Enables the specified rule. If the rule does not exist, the operation fails.

When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect.

Examples:

Request syntax with placeholder values


resp = client.enable_rule({
  name: "RuleName", # required
  event_bus_name: "EventBusNameOrArn",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the rule.

  • :event_bus_name (String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1887
1888
1889
1890
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1887

def enable_rule(params = {}, options = {})
  req = build_request(:enable_rule, params)
  req.send_request(options)
end

#list_api_destinations(params = {}) ⇒ Types::ListApiDestinationsResponse

Retrieves a list of API destination in the account in the current Region.

Examples:

Request syntax with placeholder values


resp = client.list_api_destinations({
  name_prefix: "ApiDestinationName",
  connection_arn: "ConnectionArn",
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.api_destinations #=> Array
resp.api_destinations[0].api_destination_arn #=> String
resp.api_destinations[0].name #=> String
resp.api_destinations[0].api_destination_state #=> String, one of "ACTIVE", "INACTIVE"
resp.api_destinations[0].connection_arn #=> String
resp.api_destinations[0].invocation_endpoint #=> String
resp.api_destinations[0].http_method #=> String, one of "POST", "GET", "HEAD", "OPTIONS", "PUT", "PATCH", "DELETE"
resp.api_destinations[0].invocation_rate_limit_per_second #=> Integer
resp.api_destinations[0].creation_time #=> Time
resp.api_destinations[0].last_modified_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name_prefix (String) —

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

  • :connection_arn (String) —

    The ARN of the connection specified for the API destination.

  • :next_token (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.

Returns:

See Also:



1941
1942
1943
1944
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1941

def list_api_destinations(params = {}, options = {})
  req = build_request(:list_api_destinations, params)
  req.send_request(options)
end

#list_archives(params = {}) ⇒ Types::ListArchivesResponse

Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive.

Examples:

Request syntax with placeholder values


resp = client.list_archives({
  name_prefix: "ArchiveName",
  event_source_arn: "Arn",
  state: "ENABLED", # accepts ENABLED, DISABLED, CREATING, UPDATING, CREATE_FAILED, UPDATE_FAILED
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.archives #=> Array
resp.archives[0].archive_name #=> String
resp.archives[0].event_source_arn #=> String
resp.archives[0].state #=> String, one of "ENABLED", "DISABLED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
resp.archives[0].state_reason #=> String
resp.archives[0].retention_days #=> Integer
resp.archives[0].size_bytes #=> Integer
resp.archives[0].event_count #=> Integer
resp.archives[0].creation_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name_prefix (String) —

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

  • :event_source_arn (String) —

    The ARN of the event source associated with the archive.

  • :state (String) —

    The state of the archive.

  • :next_token (String) —

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

  • :limit (Integer) —

    The maximum number of results to return.

Returns:

See Also:



1999
2000
2001
2002
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 1999

def list_archives(params = {}, options = {})
  req = build_request(:list_archives, params)
  req.send_request(options)
end

#list_connections(params = {}) ⇒ Types::ListConnectionsResponse

Retrieves a list of connections from the account.

Examples:

Request syntax with placeholder values


resp = client.list_connections({
  name_prefix: "ConnectionName",
  connection_state: "CREATING", # accepts CREATING, UPDATING, DELETING, AUTHORIZED, DEAUTHORIZED, AUTHORIZING, DEAUTHORIZING
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.connections #=> Array
resp.connections[0].connection_arn #=> String
resp.connections[0].name #=> String
resp.connections[0].connection_state #=> String, one of "CREATING", "UPDATING", "DELETING", "AUTHORIZED", "DEAUTHORIZED", "AUTHORIZING", "DEAUTHORIZING"
resp.connections[0].state_reason #=> String
resp.connections[0].authorization_type #=> String, one of "BASIC", "OAUTH_CLIENT_CREDENTIALS", "API_KEY"
resp.connections[0].creation_time #=> Time
resp.connections[0].last_modified_time #=> Time
resp.connections[0].last_authorized_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name_prefix (String) —

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

  • :connection_state (String) —

    The state of the connection.

  • :next_token (String) —

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

  • :limit (Integer) —

    The maximum number of connections to return.

Returns:

See Also:



2051
2052
2053
2054
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 2051

def list_connections(params = {}, options = {})
  req = build_request(:list_connections, params)
  req.send_request(options)
end

#list_endpoints(params = {}) ⇒ Types::ListEndpointsResponse

List the global endpoints associated with this account. For more information about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication] in the Amazon EventBridge User Guide .

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html

Examples:

Request syntax with placeholder values


resp = client.list_endpoints({
  name_prefix: "EndpointName",
  home_region: "HomeRegion",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.endpoints #=> Array
resp.endpoints[0].name #=> String
resp.endpoints[0].description #=> String
resp.endpoints[0].arn #=> String
resp.endpoints[0].routing_config.failover_config.primary.health_check #=> String
resp.endpoints[0].routing_config.failover_config.secondary.route #=> String
resp.endpoints[0].replication_config.state #=> String, one of "ENABLED", "DISABLED"
resp.endpoints[0].event_buses #=> Array
resp.endpoints[0].event_buses[0].event_bus_arn #=> String
resp.endpoints[0].role_arn #=> String
resp.endpoints[0].endpoint_id #=> String
resp.endpoints[0].endpoint_url #=> String
resp.endpoints[0].state #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
resp.endpoints[0].state_reason #=> String
resp.endpoints[0].creation_time #=> Time
resp.endpoints[0].last_modified_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name_prefix (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.

  • :home_region (String) —

    The primary Region of the endpoints associated with this account. For example ‘“HomeRegion”: “us-east-1”`.

  • :next_token (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.

  • :max_results (Integer) —

    The maximum number of results returned by the call.

Returns:

See Also:



2123
2124
2125
2126
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 2123

def list_endpoints(params = {}, options = {})
  req = build_request(:list_endpoints, params)
  req.send_request(options)
end

#list_event_buses(params = {}) ⇒ Types::ListEventBusesResponse

Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.

Examples:

Request syntax with placeholder values


resp = client.list_event_buses({
  name_prefix: "EventBusName",
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.event_buses #=> Array
resp.event_buses[0].name #=> String
resp.event_buses[0].arn #=> String
resp.event_buses[0].description #=> String
resp.event_buses[0].policy #=> String
resp.event_buses[0].creation_time #=> Time
resp.event_buses[0].last_modified_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name_prefix (String) —

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

  • :next_token (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.

Returns:

See Also:



2172
2173
2174
2175
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 2172

def list_event_buses(params = {}, options = {})
  req = build_request(:list_event_buses, params)
  req.send_request(options)
end

#list_event_sources(params = {}) ⇒ Types::ListEventSourcesResponse

You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see [CreateEventBus].

[1]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html

Examples:

Request syntax with placeholder values


resp = client.list_event_sources({
  name_prefix: "EventSourceNamePrefix",
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.event_sources #=> Array
resp.event_sources[0].arn #=> String
resp.event_sources[0].created_by #=> String
resp.event_sources[0].creation_time #=> Time
resp.event_sources[0].expiration_time #=> Time
resp.event_sources[0].name #=> String
resp.event_sources[0].state #=> String, one of "PENDING", "ACTIVE", "DELETED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name_prefix (String) —

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

  • :next_token (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.

Returns:

See Also:



2226
2227
2228
2229
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 2226

def list_event_sources(params = {}, options = {})
  req = build_request(:list_event_sources, params)
  req.send_request(options)
end

#list_partner_event_source_accounts(params = {}) ⇒ Types::ListPartnerEventSourceAccountsResponse

An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operation is not used by Amazon Web Services customers.

Examples:

Request syntax with placeholder values


resp = client.list_partner_event_source_accounts({
  event_source_name: "EventSourceName", # required
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.partner_event_source_accounts #=> Array
resp.partner_event_source_accounts[0]. #=> String
resp.partner_event_source_accounts[0].creation_time #=> Time
resp.partner_event_source_accounts[0].expiration_time #=> Time
resp.partner_event_source_accounts[0].state #=> String, one of "PENDING", "ACTIVE", "DELETED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :event_source_name (required, String) —

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

  • :next_token (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.

Returns:

See Also:



2275
2276
2277
2278
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 2275

def list_partner_event_source_accounts(params = {}, options = {})
  req = build_request(:list_partner_event_source_accounts, params)
  req.send_request(options)
end

#list_partner_event_sources(params = {}) ⇒ Types::ListPartnerEventSourcesResponse

An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services customers.

Examples:

Request syntax with placeholder values


resp = client.list_partner_event_sources({
  name_prefix: "PartnerEventSourceNamePrefix", # required
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.partner_event_sources #=> Array
resp.partner_event_sources[0].arn #=> String
resp.partner_event_sources[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name_prefix (required, String) —

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

  • :next_token (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.

Returns:

See Also:



2321
2322
2323
2324
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 2321

def list_partner_event_sources(params = {}, options = {})
  req = build_request(:list_partner_event_sources, params)
  req.send_request(options)
end

#list_replays(params = {}) ⇒ Types::ListReplaysResponse

Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive.

Examples:

Request syntax with placeholder values


resp = client.list_replays({
  name_prefix: "ReplayName",
  state: "STARTING", # accepts STARTING, RUNNING, CANCELLING, COMPLETED, CANCELLED, FAILED
  event_source_arn: "Arn",
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.replays #=> Array
resp.replays[0].replay_name #=> String
resp.replays[0].event_source_arn #=> String
resp.replays[0].state #=> String, one of "STARTING", "RUNNING", "CANCELLING", "COMPLETED", "CANCELLED", "FAILED"
resp.replays[0].state_reason #=> String
resp.replays[0].event_start_time #=> Time
resp.replays[0].event_end_time #=> Time
resp.replays[0].event_last_replayed_time #=> Time
resp.replays[0].replay_start_time #=> Time
resp.replays[0].replay_end_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name_prefix (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.

  • :event_source_arn (String) —

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

  • :next_token (String) —

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

  • :limit (Integer) —

    The maximum number of replays to retrieve.

Returns:

See Also:



2380
2381
2382
2383
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 2380

def list_replays(params = {}, options = {})
  req = build_request(:list_replays, params)
  req.send_request(options)
end

#list_rule_names_by_target(params = {}) ⇒ Types::ListRuleNamesByTargetResponse

Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account.

The maximum number of results per page for requests is 100.

Examples:

Request syntax with placeholder values


resp = client.list_rule_names_by_target({
  target_arn: "TargetArn", # required
  event_bus_name: "EventBusNameOrArn",
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.rule_names #=> Array
resp.rule_names[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :target_arn (required, String) —

    The Amazon Resource Name (ARN) of the target resource.

  • :event_bus_name (String) —

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

  • :next_token (String) —

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

  • :limit (Integer) —

    The maximum number of results to return.

Returns:

See Also:



2429
2430
2431
2432
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 2429

def list_rule_names_by_target(params = {}, options = {})
  req = build_request(:list_rule_names_by_target, params)
  req.send_request(options)
end

#list_rules(params = {}) ⇒ Types::ListRulesResponse

Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.

The maximum number of results per page for requests is 100.

ListRules does not list the targets of a rule. To see the targets associated with a rule, use [ListTargetsByRule].

[1]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html

Examples:

Request syntax with placeholder values


resp = client.list_rules({
  name_prefix: "RuleName",
  event_bus_name: "EventBusNameOrArn",
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.rules #=> Array
resp.rules[0].name #=> String
resp.rules[0].arn #=> String
resp.rules[0].event_pattern #=> String
resp.rules[0].state #=> String, one of "ENABLED", "DISABLED", "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS"
resp.rules[0].description #=> String
resp.rules[0].schedule_expression #=> String
resp.rules[0].role_arn #=> String
resp.rules[0].managed_by #=> String
resp.rules[0].event_bus_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name_prefix (String) —

    The prefix matching the rule name.

  • :event_bus_name (String) —

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

  • :next_token (String) —

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

  • :limit (Integer) —

    The maximum number of results to return.

Returns:

See Also:



2492
2493
2494
2495
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 2492

def list_rules(params = {}, options = {})
  req = build_request(:list_rules, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the EventBridge resource for which you want to view tags.

Returns:

See Also:



2523
2524
2525
2526
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 2523

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_targets_by_rule(params = {}) ⇒ Types::ListTargetsByRuleResponse

Lists the targets assigned to the specified rule.

The maximum number of results per page for requests is 100.

Examples:

Request syntax with placeholder values


resp = client.list_targets_by_rule({
  rule: "RuleName", # required
  event_bus_name: "EventBusNameOrArn",
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.targets #=> Array
resp.targets[0].id #=> String
resp.targets[0].arn #=> String
resp.targets[0].role_arn #=> String
resp.targets[0].input #=> String
resp.targets[0].input_path #=> String
resp.targets[0].input_transformer.input_paths_map #=> Hash
resp.targets[0].input_transformer.input_paths_map["InputTransformerPathKey"] #=> String
resp.targets[0].input_transformer.input_template #=> String
resp.targets[0].kinesis_parameters.partition_key_path #=> String
resp.targets[0].run_command_parameters.run_command_targets #=> Array
resp.targets[0].run_command_parameters.run_command_targets[0].key #=> String
resp.targets[0].run_command_parameters.run_command_targets[0].values #=> Array
resp.targets[0].run_command_parameters.run_command_targets[0].values[0] #=> String
resp.targets[0].ecs_parameters.task_definition_arn #=> String
resp.targets[0].ecs_parameters.task_count #=> Integer
resp.targets[0].ecs_parameters.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.subnets #=> Array
resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.security_groups #=> Array
resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.targets[0].ecs_parameters.platform_version #=> String
resp.targets[0].ecs_parameters.group #=> String
resp.targets[0].ecs_parameters.capacity_provider_strategy #=> Array
resp.targets[0].ecs_parameters.capacity_provider_strategy[0].capacity_provider #=> String
resp.targets[0].ecs_parameters.capacity_provider_strategy[0].weight #=> Integer
resp.targets[0].ecs_parameters.capacity_provider_strategy[0].base #=> Integer
resp.targets[0].ecs_parameters.enable_ecs_managed_tags #=> Boolean
resp.targets[0].ecs_parameters.enable_execute_command #=> Boolean
resp.targets[0].ecs_parameters.placement_constraints #=> Array
resp.targets[0].ecs_parameters.placement_constraints[0].type #=> String, one of "distinctInstance", "memberOf"
resp.targets[0].ecs_parameters.placement_constraints[0].expression #=> String
resp.targets[0].ecs_parameters.placement_strategy #=> Array
resp.targets[0].ecs_parameters.placement_strategy[0].type #=> String, one of "random", "spread", "binpack"
resp.targets[0].ecs_parameters.placement_strategy[0].field #=> String
resp.targets[0].ecs_parameters.propagate_tags #=> String, one of "TASK_DEFINITION"
resp.targets[0].ecs_parameters.reference_id #=> String
resp.targets[0].ecs_parameters.tags #=> Array
resp.targets[0].ecs_parameters.tags[0].key #=> String
resp.targets[0].ecs_parameters.tags[0].value #=> String
resp.targets[0].batch_parameters.job_definition #=> String
resp.targets[0].batch_parameters.job_name #=> String
resp.targets[0].batch_parameters.array_properties.size #=> Integer
resp.targets[0].batch_parameters.retry_strategy.attempts #=> Integer
resp.targets[0].sqs_parameters.message_group_id #=> String
resp.targets[0].http_parameters.path_parameter_values #=> Array
resp.targets[0].http_parameters.path_parameter_values[0] #=> String
resp.targets[0].http_parameters.header_parameters #=> Hash
resp.targets[0].http_parameters.header_parameters["HeaderKey"] #=> String
resp.targets[0].http_parameters.query_string_parameters #=> Hash
resp.targets[0].http_parameters.query_string_parameters["QueryStringKey"] #=> String
resp.targets[0].redshift_data_parameters.secret_manager_arn #=> String
resp.targets[0].redshift_data_parameters.database #=> String
resp.targets[0].redshift_data_parameters.db_user #=> String
resp.targets[0].redshift_data_parameters.sql #=> String
resp.targets[0].redshift_data_parameters.statement_name #=> String
resp.targets[0].redshift_data_parameters.with_event #=> Boolean
resp.targets[0].redshift_data_parameters.sqls #=> Array
resp.targets[0].redshift_data_parameters.sqls[0] #=> String
resp.targets[0].sage_maker_pipeline_parameters.pipeline_parameter_list #=> Array
resp.targets[0].sage_maker_pipeline_parameters.pipeline_parameter_list[0].name #=> String
resp.targets[0].sage_maker_pipeline_parameters.pipeline_parameter_list[0].value #=> String
resp.targets[0].dead_letter_config.arn #=> String
resp.targets[0].retry_policy.maximum_retry_attempts #=> Integer
resp.targets[0].retry_policy.maximum_event_age_in_seconds #=> Integer
resp.targets[0].app_sync_parameters.graph_ql_operation #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule (required, String) —

    The name of the rule.

  • :event_bus_name (String) —

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

  • :next_token (String) —

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

  • :limit (Integer) —

    The maximum number of results to return.

Returns:

See Also:



2635
2636
2637
2638
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 2635

def list_targets_by_rule(params = {}, options = {})
  req = build_request(:list_targets_by_rule, params)
  req.send_request(options)
end

#put_events(params = {}) ⇒ Types::PutEventsResponse

Sends custom events to Amazon EventBridge so that they can be matched to rules.

The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including the event and any necessary characters and keys of the JSON representation of the event. To learn more, see

Calculating PutEvents event entry size][1

in the <i> <i>Amazon

EventBridge User Guide</i> </i>

PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of 9,223,372,036,854,775,807.

<note markdown=“1”> PutEvents will only process nested JSON up to 1100 levels deep.

</note>

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html

Examples:

Request syntax with placeholder values


resp = client.put_events({
  entries: [ # required
    {
      time: Time.now,
      source: "String",
      resources: ["EventResource"],
      detail_type: "String",
      detail: "String",
      event_bus_name: "NonPartnerEventBusNameOrArn",
      trace_header: "TraceHeader",
    },
  ],
  endpoint_id: "EndpointId",
})

Response structure


resp.failed_entry_count #=> Integer
resp.data.entries #=> Array
resp.data.entries[0].event_id #=> String
resp.data.entries[0].error_code #=> String
resp.data.entries[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :entries (required, Array<Types::PutEventsRequestEntry>) —

    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.

  • :endpoint_id (String) —

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

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

Returns:

See Also:



2708
2709
2710
2711
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 2708

def put_events(params = {}, options = {})
  req = build_request(:put_events, params)
  req.send_request(options)
end

#put_partner_events(params = {}) ⇒ Types::PutPartnerEventsResponse

This is used by SaaS partners to write events to a customer’s partner event bus. Amazon Web Services customers do not use this operation.

For information on calculating event batch size, see [Calculating EventBridge PutEvents event entry size] in the *EventBridge User Guide*.

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html

Examples:

Request syntax with placeholder values


resp = client.put_partner_events({
  entries: [ # required
    {
      time: Time.now,
      source: "EventSourceName",
      resources: ["EventResource"],
      detail_type: "String",
      detail: "String",
    },
  ],
})

Response structure


resp.failed_entry_count #=> Integer
resp.data.entries #=> Array
resp.data.entries[0].event_id #=> String
resp.data.entries[0].error_code #=> String
resp.data.entries[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



2758
2759
2760
2761
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 2758

def put_partner_events(params = {}, options = {})
  req = build_request(:put_partner_events, params)
  req.send_request(options)
end

#put_permission(params = {}) ⇒ Struct

Running ‘PutPermission` permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified *event bus*. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account.

For another account to send events to your account, that external account must have an EventBridge rule with your account’s event bus as a target.

To enable multiple Amazon Web Services accounts to put events to your event bus, run ‘PutPermission` once for each of these accounts. Or, if all the accounts are members of the same Amazon Web Services organization, you can run `PutPermission` once specifying `Principal` as “*” and specifying the Amazon Web Services organization ID in `Condition`, to grant permissions to all accounts in that organization.

If you grant permissions using an organization, then accounts in that organization must specify a ‘RoleArn` with proper permissions when they use `PutTarget` to add your account’s event bus as a target. For more information, see [Sending and Receiving Events Between Amazon Web Services Accounts] in the *Amazon EventBridge User Guide*.

The permission policy on the event bus cannot exceed 10 KB in size.

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html

Examples:

Request syntax with placeholder values


resp = client.put_permission({
  event_bus_name: "NonPartnerEventBusName",
  action: "Action",
  principal: "Principal",
  statement_id: "StatementId",
  condition: {
    type: "String", # required
    key: "String", # required
    value: "String", # required
  },
  policy: "String",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :event_bus_name (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.

  • :statement_id (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 markdown=“1”> Each ‘StatementId` must be unique.

    </note>

    [1]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html

  • :condition (Types::Condition) —

    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.

    [1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2871
2872
2873
2874
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 2871

def put_permission(params = {}, options = {})
  req = build_request(:put_permission, params)
  req.send_request(options)
end

#put_rule(params = {}) ⇒ Types::PutRuleResponse

Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using [DisableRule].

A single rule watches for events from a single event bus. Events generated by Amazon Web Services services go to your account’s default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see [CreateEventBus].

If you are updating an existing rule, the rule is replaced with what you specify in this ‘PutRule` command. If you omit arguments in `PutRule`, the old values for those arguments are not kept. Instead, they are replaced with null values.

When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.

A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.

When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the ‘PutRule` operation and assign tags, you must have both the `events:PutRule` and `events:TagResource` permissions.

If you are updating an existing rule, any tags you specify in the ‘PutRule` operation are ignored. To update the tags of an existing rule, use [TagResource] and [UntagResource].

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.

To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.

An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see [Managing Your Costs with Budgets].

[1]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html [2]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html [3]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_TagResource.html [4]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_UntagResource.html [5]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html

Examples:

Request syntax with placeholder values


resp = client.put_rule({
  name: "RuleName", # required
  schedule_expression: "ScheduleExpression",
  event_pattern: "EventPattern",
  state: "ENABLED", # accepts ENABLED, DISABLED, ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS
  description: "RuleDescription",
  role_arn: "RoleArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  event_bus_name: "EventBusNameOrArn",
})

Response structure


resp.rule_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



3046
3047
3048
3049
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 3046

def put_rule(params = {}, options = {})
  req = build_request(:put_rule, params)
  req.send_request(options)
end

#put_targets(params = {}) ⇒ Types::PutTargetsResponse

Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

Targets are the resources that are invoked when a rule is triggered.

The maximum number of entries per request is 10.

<note markdown=“1”> Each rule can have up to five (5) targets associated with it at one time.

</note>

For a list of services you can configure as targets for events, see

EventBridge targets][1

in the <i> <i>Amazon EventBridge User

Guide</i> </i>.

Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The built-in targets are:

  • ‘Amazon EBS CreateSnapshot API call`

  • ‘Amazon EC2 RebootInstances API call`

  • ‘Amazon EC2 StopInstances API call`

  • ‘Amazon EC2 TerminateInstances API call`

For some target types, ‘PutTargets` provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field.

To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions:

  • For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.

  • For EC2 instances, Kinesis Data Streams, Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the ‘RoleARN` argument in `PutTargets`.

For more information, see [Authentication and Access Control] in the Amazon EventBridge User Guide .

If another Amazon Web Services account is in the same region and has granted you permission (using ‘PutPermission`), you can send events to that account. Set that account’s event bus as a target of the rules in your account. To send the matched events to the other account, specify that account’s event bus as the ‘Arn` value when you run `PutTargets`. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see [Amazon EventBridge Pricing].

<note markdown=“1”> ‘Input`, `InputPath`, and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different Amazon Web Services account.

</note>

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a ‘RoleArn` with proper permissions in the `Target` structure. For more information, see [Sending and Receiving Events Between Amazon Web Services Accounts] in the *Amazon EventBridge User Guide*.

<note markdown=“1”> If you have an IAM role on a cross-account event bus target, a ‘PutTargets` call without a role on the same target (same `Id` and `Arn`) will not remove the role.

</note>

For more information about enabling cross-account events, see [PutPermission].

Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:

  • If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).

  • If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.

  • If InputPath is specified in the form of JSONPath (for example, ‘$.detail`), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).

  • If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

When you specify ‘InputPath` or `InputTransformer`, you must use JSON dot notation, not bracket notation.

When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.

This action can partially fail if too many requests are made at the same time. If that happens, ‘FailedEntryCount` is non-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code.

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html [2]: docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html [3]: aws.amazon.com/eventbridge/pricing/ [4]: docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html [5]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html

Examples:

Request syntax with placeholder values


resp = client.put_targets({
  rule: "RuleName", # required
  event_bus_name: "EventBusNameOrArn",
  targets: [ # required
    {
      id: "TargetId", # required
      arn: "TargetArn", # required
      role_arn: "RoleArn",
      input: "TargetInput",
      input_path: "TargetInputPath",
      input_transformer: {
        input_paths_map: {
          "InputTransformerPathKey" => "TargetInputPath",
        },
        input_template: "TransformerInput", # required
      },
      kinesis_parameters: {
        partition_key_path: "TargetPartitionKeyPath", # required
      },
      run_command_parameters: {
        run_command_targets: [ # required
          {
            key: "RunCommandTargetKey", # required
            values: ["RunCommandTargetValue"], # required
          },
        ],
      },
      ecs_parameters: {
        task_definition_arn: "Arn", # required
        task_count: 1,
        launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
        network_configuration: {
          awsvpc_configuration: {
            subnets: ["String"], # required
            security_groups: ["String"],
            assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
          },
        },
        platform_version: "String",
        group: "String",
        capacity_provider_strategy: [
          {
            capacity_provider: "CapacityProvider", # required
            weight: 1,
            base: 1,
          },
        ],
        enable_ecs_managed_tags: false,
        enable_execute_command: false,
        placement_constraints: [
          {
            type: "distinctInstance", # accepts distinctInstance, memberOf
            expression: "PlacementConstraintExpression",
          },
        ],
        placement_strategy: [
          {
            type: "random", # accepts random, spread, binpack
            field: "PlacementStrategyField",
          },
        ],
        propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION
        reference_id: "ReferenceId",
        tags: [
          {
            key: "TagKey", # required
            value: "TagValue", # required
          },
        ],
      },
      batch_parameters: {
        job_definition: "String", # required
        job_name: "String", # required
        array_properties: {
          size: 1,
        },
        retry_strategy: {
          attempts: 1,
        },
      },
      sqs_parameters: {
        message_group_id: "MessageGroupId",
      },
      http_parameters: {
        path_parameter_values: ["PathParameter"],
        header_parameters: {
          "HeaderKey" => "HeaderValue",
        },
        query_string_parameters: {
          "QueryStringKey" => "QueryStringValue",
        },
      },
      redshift_data_parameters: {
        secret_manager_arn: "RedshiftSecretManagerArn",
        database: "Database", # required
        db_user: "DbUser",
        sql: "Sql",
        statement_name: "StatementName",
        with_event: false,
        sqls: ["Sql"],
      },
      sage_maker_pipeline_parameters: {
        pipeline_parameter_list: [
          {
            name: "SageMakerPipelineParameterName", # required
            value: "SageMakerPipelineParameterValue", # required
          },
        ],
      },
      dead_letter_config: {
        arn: "ResourceArn",
      },
      retry_policy: {
        maximum_retry_attempts: 1,
        maximum_event_age_in_seconds: 1,
      },
      app_sync_parameters: {
        graph_ql_operation: "GraphQLOperation",
      },
    },
  ],
})

Response structure


resp.failed_entry_count #=> Integer
resp.failed_entries #=> Array
resp.failed_entries[0].target_id #=> String
resp.failed_entries[0].error_code #=> String
resp.failed_entries[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule (required, String) —

    The name of the rule.

  • :event_bus_name (String) —

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

  • :targets (required, Array<Types::Target>) —

    The targets to update or add to the rule.

Returns:

See Also:



3323
3324
3325
3326
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 3323

def put_targets(params = {}, options = {})
  req = build_request(:put_targets, params)
  req.send_request(options)
end

#remove_permission(params = {}) ⇒ Struct

Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus. Specify the account to revoke by the ‘StatementId` value that you associated with the account when you granted it permission with `PutPermission`. You can find the `StatementId` by using [DescribeEventBus].

[1]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventBus.html

Examples:

Request syntax with placeholder values


resp = client.remove_permission({
  statement_id: "StatementId",
  remove_all_permissions: false,
  event_bus_name: "NonPartnerEventBusName",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :statement_id (String) —

    The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.

  • :remove_all_permissions (Boolean) —

    Specifies whether to remove all permissions.

  • :event_bus_name (String) —

    The name of the event bus to revoke permissions for. If you omit this, the default event bus is used.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3363
3364
3365
3366
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 3363

def remove_permission(params = {}, options = {})
  req = build_request(:remove_permission, params)
  req.send_request(options)
end

#remove_targets(params = {}) ⇒ Types::RemoveTargetsResponse

Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.

<note markdown=“1”> A successful execution of ‘RemoveTargets` doesn’t guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.

</note>

When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect.

This action can partially fail if too many requests are made at the same time. If that happens, ‘FailedEntryCount` is non-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code.

The maximum number of entries per request is 10.

Examples:

Request syntax with placeholder values


resp = client.remove_targets({
  rule: "RuleName", # required
  event_bus_name: "EventBusNameOrArn",
  ids: ["TargetId"], # required
  force: false,
})

Response structure


resp.failed_entry_count #=> Integer
resp.failed_entries #=> Array
resp.failed_entries[0].target_id #=> String
resp.failed_entries[0].error_code #=> String
resp.failed_entries[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule (required, String) —

    The name of the rule.

  • :event_bus_name (String) —

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

  • :ids (required, Array<String>) —

    The IDs of the targets to remove from the rule.

  • :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 remove targets. 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.

Returns:

See Also:



3431
3432
3433
3434
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 3431

def remove_targets(params = {}, options = {})
  req = build_request(:remove_targets, params)
  req.send_request(options)
end

#start_replay(params = {}) ⇒ Types::StartReplayResponse

Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an ‘EventStartTime` and an `EventEndTime` that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use `DescribeReplay` to determine the progress of a replay. The value returned for `EventLastReplayedTime` indicates the time within the specified time range associated with the last event replayed.

Examples:

Request syntax with placeholder values


resp = client.start_replay({
  replay_name: "ReplayName", # required
  description: "ReplayDescription",
  event_source_arn: "Arn", # required
  event_start_time: Time.now, # required
  event_end_time: Time.now, # required
  destination: { # required
    arn: "Arn", # required
    filter_arns: ["Arn"],
  },
})

Response structure


resp.replay_arn #=> String
resp.state #=> String, one of "STARTING", "RUNNING", "CANCELLING", "COMPLETED", "CANCELLED", "FAILED"
resp.state_reason #=> String
resp.replay_start_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :replay_name (required, String) —

    The name of the replay to start.

  • :description (String) —

    A description for the replay to start.

  • :event_source_arn (required, String) —

    The ARN of the archive to replay events from.

  • :event_start_time (required, Time, DateTime, Date, Integer, String) —

    A time stamp for the time to start replaying events. Only events that occurred between the ‘EventStartTime` and `EventEndTime` are replayed.

  • :event_end_time (required, Time, DateTime, Date, Integer, String) —

    A time stamp for the time to stop replaying events. Only events that occurred between the ‘EventStartTime` and `EventEndTime` are replayed.

  • :destination (required, Types::ReplayDestination) —

    A ‘ReplayDestination` object that includes details about the destination for the replay.

Returns:

See Also:



3500
3501
3502
3503
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 3500

def start_replay(params = {}, options = {})
  req = build_request(:start_replay, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged.

Tags don’t have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the ‘TagResource` action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the EventBridge resource that you’re adding tags to.

  • :tags (required, Array<Types::Tag>) —

    The list of key-value pairs to associate with the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3546
3547
3548
3549
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 3546

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#test_event_pattern(params = {}) ⇒ Types::TestEventPatternResponse

Tests whether the specified event pattern matches the provided event.

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

Examples:

Request syntax with placeholder values


resp = client.test_event_pattern({
  event_pattern: "EventPattern", # required
  event: "String", # required
})

Response structure


resp.result #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



3609
3610
3611
3612
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 3609

def test_event_pattern(params = {}, options = {})
  req = build_request(:test_event_pattern, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the EventBridge resource from which you are removing tags.

  • :tag_keys (required, Array<String>) —

    The list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3637
3638
3639
3640
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 3637

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_api_destination(params = {}) ⇒ Types::UpdateApiDestinationResponse

Updates an API destination.

Examples:

Request syntax with placeholder values


resp = client.update_api_destination({
  name: "ApiDestinationName", # required
  description: "ApiDestinationDescription",
  connection_arn: "ConnectionArn",
  invocation_endpoint: "HttpsEndpoint",
  http_method: "POST", # accepts POST, GET, HEAD, OPTIONS, PUT, PATCH, DELETE
  invocation_rate_limit_per_second: 1,
})

Response structure


resp.api_destination_arn #=> String
resp.api_destination_state #=> String, one of "ACTIVE", "INACTIVE"
resp.creation_time #=> Time
resp.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the API destination to update.

  • :description (String) —

    The name of the API destination to update.

  • :connection_arn (String) —

    The ARN of the connection to use for the API destination.

  • :invocation_endpoint (String) —

    The URL to the endpoint to use for the API destination.

  • :http_method (String) —

    The method to use for the API destination.

  • :invocation_rate_limit_per_second (Integer) —

    The maximum number of invocations per second to send to the API destination.

Returns:

See Also:



3692
3693
3694
3695
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 3692

def update_api_destination(params = {}, options = {})
  req = build_request(:update_api_destination, params)
  req.send_request(options)
end

#update_archive(params = {}) ⇒ Types::UpdateArchiveResponse

Updates the specified archive.

Examples:

Request syntax with placeholder values


resp = client.update_archive({
  archive_name: "ArchiveName", # required
  description: "ArchiveDescription",
  event_pattern: "EventPattern",
  retention_days: 1,
})

Response structure


resp.archive_arn #=> String
resp.state #=> String, one of "ENABLED", "DISABLED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
resp.state_reason #=> String
resp.creation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :archive_name (required, String) —

    The name of the archive to update.

  • :description (String) —

    The description for the archive.

  • :event_pattern (String) —

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

  • :retention_days (Integer) —

    The number of days to retain events in the archive.

Returns:

See Also:



3738
3739
3740
3741
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 3738

def update_archive(params = {}, options = {})
  req = build_request(:update_archive, params)
  req.send_request(options)
end

#update_connection(params = {}) ⇒ Types::UpdateConnectionResponse

Updates settings for a connection.

Examples:

Request syntax with placeholder values


resp = client.update_connection({
  name: "ConnectionName", # required
  description: "ConnectionDescription",
  authorization_type: "BASIC", # accepts BASIC, OAUTH_CLIENT_CREDENTIALS, API_KEY
  auth_parameters: {
    basic_auth_parameters: {
      username: "AuthHeaderParameters",
      password: "AuthHeaderParametersSensitive",
    },
    o_auth_parameters: {
      client_parameters: {
        client_id: "AuthHeaderParameters",
        client_secret: "AuthHeaderParametersSensitive",
      },
      authorization_endpoint: "HttpsEndpoint",
      http_method: "GET", # accepts GET, POST, PUT
      o_auth_http_parameters: {
        header_parameters: [
          {
            key: "HeaderKey",
            value: "HeaderValueSensitive",
            is_value_secret: false,
          },
        ],
        query_string_parameters: [
          {
            key: "QueryStringKey",
            value: "QueryStringValueSensitive",
            is_value_secret: false,
          },
        ],
        body_parameters: [
          {
            key: "String",
            value: "SensitiveString",
            is_value_secret: false,
          },
        ],
      },
    },
    api_key_auth_parameters: {
      api_key_name: "AuthHeaderParameters",
      api_key_value: "AuthHeaderParametersSensitive",
    },
    invocation_http_parameters: {
      header_parameters: [
        {
          key: "HeaderKey",
          value: "HeaderValueSensitive",
          is_value_secret: false,
        },
      ],
      query_string_parameters: [
        {
          key: "QueryStringKey",
          value: "QueryStringValueSensitive",
          is_value_secret: false,
        },
      ],
      body_parameters: [
        {
          key: "String",
          value: "SensitiveString",
          is_value_secret: false,
        },
      ],
    },
  },
})

Response structure


resp.connection_arn #=> String
resp.connection_state #=> String, one of "CREATING", "UPDATING", "DELETING", "AUTHORIZED", "DEAUTHORIZED", "AUTHORIZING", "DEAUTHORIZING"
resp.creation_time #=> Time
resp.last_modified_time #=> Time
resp.last_authorized_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the connection to update.

  • :description (String) —

    A description for the connection.

  • :authorization_type (String) —

    The type of authorization to use for the connection.

  • :auth_parameters (Types::UpdateConnectionAuthRequestParameters) —

    The authorization parameters to use for the connection.

Returns:

See Also:



3849
3850
3851
3852
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 3849

def update_connection(params = {}, options = {})
  req = build_request(:update_connection, params)
  req.send_request(options)
end

#update_endpoint(params = {}) ⇒ Types::UpdateEndpointResponse

Update an existing endpoint. For more information about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication] in the Amazon EventBridge User Guide .

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html

Examples:

Request syntax with placeholder values


resp = client.update_endpoint({
  name: "EndpointName", # required
  description: "EndpointDescription",
  routing_config: {
    failover_config: { # required
      primary: { # required
        health_check: "HealthCheck", # required
      },
      secondary: { # required
        route: "Route", # required
      },
    },
  },
  replication_config: {
    state: "ENABLED", # accepts ENABLED, DISABLED
  },
  event_buses: [
    {
      event_bus_arn: "NonPartnerEventBusArn", # required
    },
  ],
  role_arn: "IamRoleArn",
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.routing_config.failover_config.primary.health_check #=> String
resp.routing_config.failover_config.secondary.route #=> String
resp.replication_config.state #=> String, one of "ENABLED", "DISABLED"
resp.event_buses #=> Array
resp.event_buses[0].event_bus_arn #=> String
resp.role_arn #=> String
resp.endpoint_id #=> String
resp.endpoint_url #=> String
resp.state #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the endpoint you want to update.

  • :description (String) —

    A description for the endpoint.

  • :routing_config (Types::RoutingConfig) —

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

  • :replication_config (Types::ReplicationConfig) —

    Whether event replication was enabled or disabled by this request.

  • :event_buses (Array<Types::EndpointEventBus>) —

    Define event buses used for replication.

  • :role_arn (String) —

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

Returns:

See Also:



3938
3939
3940
3941
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 3938

def update_endpoint(params = {}, options = {})
  req = build_request(:update_endpoint, params)
  req.send_request(options)
end

#update_event_bus(params = {}) ⇒ Types::UpdateEventBusResponse

Updates the specified event bus.

Examples:

Request syntax with placeholder values


resp = client.update_event_bus({
  name: "EventBusName",
  kms_key_identifier: "KmsKeyIdentifier",
  description: "EventBusDescription",
  dead_letter_config: {
    arn: "ResourceArn",
  },
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.kms_key_identifier #=> String
resp.description #=> String
resp.dead_letter_config.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (String) —

    The name of the event bus.

  • :kms_key_identifier (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 markdown=“1”> 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*.

    </note>

    [1]: docs.aws.amazon.com/kms/latest/developerguide/getting-started.html [2]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html

  • :description (String) —

    The event bus description.

  • :dead_letter_config (Types::DeadLetterConfig) —

    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](eventbridge/latest/userguide/eb-rule-dlq.html) in the *EventBridge User Guide*.

Returns:

See Also:



4027
4028
4029
4030
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 4027

def update_event_bus(params = {}, options = {})
  req = build_request(:update_event_bus, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


4056
4057
4058
 
# File 'lib/aws-sdk-eventbridge/client.rb', line 4056

def waiter_names
  []
end