List Connections

eventbridge_list_connections

R Documentation

Retrieves a list of connections from the account

Description

Retrieves a list of connections from the account.

Usage

eventbridge_list_connections(NamePrefix, ConnectionState, NextToken,
  Limit)

Arguments

NamePrefix

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

ConnectionState

The state of the connection.

NextToken

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an ⁠HTTP 400 InvalidToken⁠ error.

Limit

The maximum number of connections to return.

Value

A list with the following syntax:

list(
  Connections = list(
    list(
      ConnectionArn = "string",
      Name = "string",
      ConnectionState = "CREATING"|"UPDATING"|"DELETING"|"AUTHORIZED"|"DEAUTHORIZED"|"AUTHORIZING"|"DEAUTHORIZING"|"ACTIVE"|"FAILED_CONNECTIVITY",
      StateReason = "string",
      AuthorizationType = "BASIC"|"OAUTH_CLIENT_CREDENTIALS"|"API_KEY",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastAuthorizedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_connections(
  NamePrefix = "string",
  ConnectionState = "CREATING"|"UPDATING"|"DELETING"|"AUTHORIZED"|"DEAUTHORIZED"|"AUTHORIZING"|"DEAUTHORIZING"|"ACTIVE"|"FAILED_CONNECTIVITY",
  NextToken = "string",
  Limit = 123
)