List Api Destinations

eventbridge_list_api_destinations

R Documentation

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

Description

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

Usage

eventbridge_list_api_destinations(NamePrefix, ConnectionArn, NextToken,
  Limit)

Arguments

NamePrefix

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

ConnectionArn

The ARN of the connection specified for the API destination.

NextToken

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

Limit

The maximum number of API destinations to include in the response.

Value

A list with the following syntax:

list(
  ApiDestinations = list(
    list(
      ApiDestinationArn = "string",
      Name = "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"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_api_destinations(
  NamePrefix = "string",
  ConnectionArn = "string",
  NextToken = "string",
  Limit = 123
)