Skip to content

Update Api Destination

eventbridge_update_api_destination R Documentation

Updates an API destination

Description

Updates an API destination.

Usage

eventbridge_update_api_destination(Name, Description, ConnectionArn,
  InvocationEndpoint, HttpMethod, InvocationRateLimitPerSecond)

Arguments

Name

[required] The name of the API destination to update.

Description

The name of the API destination to update.

ConnectionArn

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

InvocationEndpoint

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

HttpMethod

The method to use for the API destination.

InvocationRateLimitPerSecond

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

Value

A list with the following syntax:

list(
  ApiDestinationArn = "string",
  ApiDestinationState = "ACTIVE"|"INACTIVE",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$update_api_destination(
  Name = "string",
  Description = "string",
  ConnectionArn = "string",
  InvocationEndpoint = "string",
  HttpMethod = "POST"|"GET"|"HEAD"|"OPTIONS"|"PUT"|"PATCH"|"DELETE",
  InvocationRateLimitPerSecond = 123
)