CodeConnections / Client / get_host

get_host#

CodeConnections.Client.get_host(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.get_host(
    HostArn='string'
)
Parameters:

HostArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'Status': 'string',
    'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
    'ProviderEndpoint': 'string',
    'VpcConfiguration': {
        'VpcId': 'string',
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'TlsCertificate': 'string'
    }
}

Response Structure

  • (dict) –

    • 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 (dict) –

      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.

Exceptions