GetHost - AWS CodeStar Connections

GetHost

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

Request Syntax

{ "HostArn": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

HostArn

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: arn:aws(-[\w]+)*:codestar-connections:.+:[0-9]{12}:host\/.+

Required: Yes

Response Syntax

{ "Name": "string", "ProviderEndpoint": "string", "ProviderType": "string", "Status": "string", "VpcConfiguration": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "TlsCertificate": "string", "VpcId": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Name

The name of the requested host.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: .*

ProviderEndpoint

The endpoint of the infrastructure represented by the requested host.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: .*

ProviderType

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

Type: String

Valid Values: Bitbucket | GitHub | GitHubEnterpriseServer

Status

The status of the requested host.

Type: String

VpcConfiguration

The VPC configuration of the requested host.

Type: VpcConfiguration object

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

Resource not found. Verify the connection resource ARN and try again.

HTTP Status Code: 400

ResourceUnavailableException

Resource not found. Verify the ARN for the host resource and try again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: