Skip to content

Describe Api Destination

eventbridge_describe_api_destination R Documentation

Retrieves details about an API destination

Description

Retrieves details about an API destination.

Usage

eventbridge_describe_api_destination(Name)

Arguments

Name

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

Value

A list with the following syntax:

list(
  ApiDestinationArn = "string",
  Name = "string",
  Description = "string",
  ApiDestinationState = "ACTIVE"|"INACTIVE",
  ConnectionArn = "string",
  InvocationEndpoint = "string",
  HttpMethod = "POST"|"GET"|"HEAD"|"OPTIONS"|"PUT"|"PATCH"|"DELETE",
  InvocationRateLimitPerSecond = 123,
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$describe_api_destination(
  Name = "string"
)