CodeStarconnections / Client / list_hosts

list_hosts#

CodeStarconnections.Client.list_hosts(**kwargs)#

Lists the hosts associated with your account.

See also: AWS API Documentation

Request Syntax

response = client.list_hosts(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – 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 (string) – The token that was returned from the previous ListHosts call, which can be used to return the next set of hosts in the list.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Hosts (list) –

      A list of hosts and the details for each host, such as status, endpoint, and provider type.

      • (dict) –

        A resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider.

        Note

        A host created through the CLI or the SDK is in PENDING status by default. You can make its status AVAILABLE by setting up the host in the console.

        • Name (string) –

          The name of the host.

        • HostArn (string) –

          The Amazon Resource Name (ARN) of the host.

        • ProviderType (string) –

          The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.

        • ProviderEndpoint (string) –

          The endpoint of the infrastructure where your provider type is installed.

        • VpcConfiguration (dict) –

          The VPC configuration provisioned for the 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.

        • Status (string) –

          The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

        • StatusMessage (string) –

          The status description for the host.

    • NextToken (string) –

      A token that can be used in the next ListHosts call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.