Skip to content

Get Connection

codestarconnections_get_connection R Documentation

Returns the connection ARN and details such as status, owner, and provider type

Description

Returns the connection ARN and details such as status, owner, and provider type.

Usage

codestarconnections_get_connection(ConnectionArn)

Arguments

ConnectionArn

[required] The Amazon Resource Name (ARN) of a connection.

Value

A list with the following syntax:

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

Request syntax

svc$get_connection(
  ConnectionArn = "string"
)