Skip to content

List Connections

codestarconnections_list_connections R Documentation

Lists the connections associated with your account

Description

Lists the connections associated with your account.

Usage

codestarconnections_list_connections(ProviderTypeFilter, HostArnFilter,
  MaxResults, NextToken)

Arguments

ProviderTypeFilter

Filters the list of connections to those associated with a specified provider, such as Bitbucket.

HostArnFilter

Filters the list of connections to those associated with a specified host.

MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

NextToken

The token that was returned from the previous list_connections call, which can be used to return the next set of connections in the list.

Value

A list with the following syntax:

list(
  Connections = list(
    list(
      ConnectionName = "string",
      ConnectionArn = "string",
      ProviderType = "Bitbucket"|"GitHub"|"GitHubEnterpriseServer"|"GitLab"|"GitLabSelfManaged",
      OwnerAccountId = "string",
      ConnectionStatus = "PENDING"|"AVAILABLE"|"ERROR",
      HostArn = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_connections(
  ProviderTypeFilter = "Bitbucket"|"GitHub"|"GitHubEnterpriseServer"|"GitLab"|"GitLabSelfManaged",
  HostArnFilter = "string",
  MaxResults = 123,
  NextToken = "string"
)