paws.management (version 0.5.0)

cloudwatchevents: 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
)

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.

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.

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_sourceActivates a partner event source that has been deactivated
cancel_replayCancels the specified replay
create_api_destinationCreates an API destination, which is an HTTP invocation endpoint configured as a target for events
create_archiveCreates an archive of events with the specified settings
create_connectionCreates a connection
create_event_busCreates a new event bus within your account
create_partner_event_sourceCalled by an SaaS partner to create a partner event source
deactivate_event_sourceYou can use this operation to temporarily stop receiving events from the specified partner event source
deauthorize_connectionRemoves all authorization parameters from the connection
delete_api_destinationDeletes the specified API destination
delete_archiveDeletes the specified archive
delete_connectionDeletes a connection
delete_event_busDeletes the specified custom event bus or partner event bus
delete_partner_event_sourceThis operation is used by SaaS partners to delete a partner event source
delete_ruleDeletes the specified rule
describe_api_destinationRetrieves details about an API destination
describe_archiveRetrieves details about an archive
describe_connectionRetrieves details about a connection
describe_event_busDisplays details about an event bus in your account
describe_event_sourceThis operation lists details about a partner event source that is shared with your account
describe_partner_event_sourceAn SaaS partner can use this operation to list details about a partner event source that they have created
describe_replayRetrieves details about a replay
describe_ruleDescribes the specified rule
disable_ruleDisables the specified rule
enable_ruleEnables the specified rule
list_api_destinationsRetrieves a list of API destination in the account in the current Region
list_archivesLists your archives
list_connectionsRetrieves a list of connections from the account
list_event_busesLists all the event buses in your account, including the default event bus, custom event buses, and partner event buses
list_event_sourcesYou can use this to see all the partner event sources that have been shared with your Amazon Web Services account
list_partner_event_source_accountsAn 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_sourcesAn SaaS partner can use this operation to list all the partner event source names that they have created
list_replaysLists your replays
list_rule_names_by_targetLists the rules for the specified target
list_rulesLists your Amazon EventBridge rules
list_tags_for_resourceDisplays the tags associated with an EventBridge resource
list_targets_by_ruleLists the targets assigned to the specified rule
put_eventsSends custom events to Amazon EventBridge so that they can be matched to rules
put_partner_eventsThis is used by SaaS partners to write events to a customer's partner event bus
put_permissionRunning PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus
put_ruleCreates or updates the specified rule
put_targetsAdds the specified targets to the specified rule, or updates the targets if they are already associated with the rule
remove_permissionRevokes the permission of another Amazon Web Services account to be able to put events to the specified event bus
remove_targetsRemoves the specified targets from the specified rule
start_replayStarts the specified replay
tag_resourceAssigns one or more tags (key-value pairs) to the specified EventBridge resource
test_event_patternTests whether the specified event pattern matches the provided event
untag_resourceRemoves one or more tags from the specified EventBridge resource
update_api_destinationUpdates an API destination
update_archiveUpdates the specified archive
update_connectionUpdates settings for a connection

Examples

Run this code
if (FALSE) {
svc <- cloudwatchevents()
svc$activate_event_source(
  Foo = 123
)
}

Run the code above in your browser using DataLab