Client

cloudwatchevents

R Documentation

Amazon CloudWatch Events¶

Description¶

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your resources change state, they automatically send events to an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a predetermined schedule. For example, you can configure rules to:

Automatically invoke an Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.
Direct specific API records from CloudTrail to an Amazon Kinesis data stream for detailed analysis of potential security or availability risks.
Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User Guide.

Usage¶

cloudwatchevents(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- cloudwatchevents(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

activate_event_source: Activates a partner event source that has been deactivated
cancel_replay: Cancels the specified replay
create_api_destination: Creates an API destination, which is an HTTP invocation endpoint configured as a target for events
create_archive: Creates an archive of events with the specified settings
create_connection: Creates a connection
create_event_bus: Creates a new event bus within your account
create_partner_event_source: Called by an SaaS partner to create a partner event source
deactivate_event_source: You can use this operation to temporarily stop receiving events from the specified partner event source
deauthorize_connection: Removes all authorization parameters from the connection
delete_api_destination: Deletes the specified API destination
delete_archive: Deletes the specified archive
delete_connection: Deletes a connection
delete_event_bus: Deletes the specified custom event bus or partner event bus
delete_partner_event_source: This operation is used by SaaS partners to delete a partner event source
delete_rule: Deletes the specified rule
describe_api_destination: Retrieves details about an API destination
describe_archive: Retrieves details about an archive
describe_connection: Retrieves details about a connection
describe_event_bus: Displays details about an event bus in your account
describe_event_source: This operation lists details about a partner event source that is shared with your account
describe_partner_event_source: An SaaS partner can use this operation to list details about a partner event source that they have created
describe_replay: Retrieves details about a replay
describe_rule: Describes the specified rule
disable_rule: Disables the specified rule
enable_rule: Enables the specified rule
list_api_destinations: Retrieves a list of API destination in the account in the current Region
list_archives: Lists your archives
list_connections: Retrieves a list of connections from the account
list_event_buses: Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses
list_event_sources: You can use this to see all the partner event sources that have been shared with your Amazon Web Services account
list_partner_event_source_accounts: 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
list_partner_event_sources: An SaaS partner can use this operation to list all the partner event source names that they have created
list_replays: Lists your replays
list_rule_names_by_target: Lists the rules for the specified target
list_rules: Lists your Amazon EventBridge rules
list_tags_for_resource: Displays the tags associated with an EventBridge resource
list_targets_by_rule: Lists the targets assigned to the specified rule
put_events: Sends custom events to Amazon EventBridge so that they can be matched to rules
put_partner_events: This is used by SaaS partners to write events to a customer's partner event bus
put_permission: Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus
put_rule: Creates or updates the specified rule
put_targets: Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule
remove_permission: Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus
remove_targets: Removes the specified targets from the specified rule
start_replay: Starts the specified replay
tag_resource: Assigns one or more tags (key-value pairs) to the specified EventBridge resource
test_event_pattern: Tests whether the specified event pattern matches the provided event
untag_resource: Removes one or more tags from the specified EventBridge resource
update_api_destination: Updates an API destination
update_archive: Updates the specified archive
update_connection: Updates settings for a connection

Examples¶

## Not run: 
svc <- cloudwatchevents()
svc$activate_event_source(
  Foo = 123
)

## End(Not run)