Skip to content

List Connections

cloudwatchevents_list_connections R Documentation

Retrieves a list of connections from the account

Description

Retrieves a list of connections from the account.

Usage

cloudwatchevents_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 to retrieve the next set of results.

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",
      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",
  NextToken = "string",
  Limit = 123
)