Skip to content

Get Host

codestarconnections_get_host R Documentation

Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration

Description

Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.

Usage

codestarconnections_get_host(HostArn)

Arguments

HostArn

[required] The Amazon Resource Name (ARN) of the requested host.

Value

A list with the following syntax:

list(
  Name = "string",
  Status = "string",
  ProviderType = "Bitbucket"|"GitHub"|"GitHubEnterpriseServer"|"GitLab"|"GitLabSelfManaged",
  ProviderEndpoint = "string",
  VpcConfiguration = list(
    VpcId = "string",
    SubnetIds = list(
      "string"
    ),
    SecurityGroupIds = list(
      "string"
    ),
    TlsCertificate = "string"
  )
)

Request syntax

svc$get_host(
  HostArn = "string"
)