get-host¶

Description¶

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

Synopsis¶

  get-host
--host-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--host-arn (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To get information about a host

The following get-host example shows details about a host:

aws codestar-connections get-host \
    --host-arn arn:aws:codestar-connections:us-east-1:123456789012:host/MyHost-28aef605

Output:

{
    "Name": "MyHost",
    "Status": "AVAILABLE",
    "ProviderType": "GitHubEnterpriseServer",
    "ProviderEndpoint": "https://test-instance-1.dev/"
}

For more information, see View host details (CLI) in the Developer Tools console User Guide.

Output¶

Name -> (string)

The name of the requested host.

Status -> (string)

The status of the requested host.

ProviderType -> (string)

The provider type of the requested host, such as GitHub Enterprise Server.

ProviderEndpoint -> (string)

The endpoint of the infrastructure represented by the requested host.

VpcConfiguration -> (structure)

The VPC configuration of the requested host.

VpcId -> (string)

The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

SubnetIds -> (list)

The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

(string)

SecurityGroupIds -> (list)

The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

(string)

TlsCertificate -> (string)

The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

Table of Contents

Feedback

User Guide