<a id="cli-aws-route53-get-health-check-source"></a>

# get-health-check-source

## Description

Gets information about a specified health check source, including its status and the virtual private cloud (VPC), subnets, and security groups that it uses.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetHealthCheckSource)

## Synopsis

```
  get-health-check-source
--health-check-source-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`--health-check-source-id` (string) [required]

> The ID of the health check source that you want to get information about.

> Constraints:

> * min: `1`
> * max: `64`

`--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Output

HealthCheckSource -> (structure)

> A complex type that contains information about the specified health check source.

> HealthCheckSourceId -> (string) [required]

> > The ID of the health check source. Route 53 assigns this ID when it creates the source.

> > Constraints:

> > * min: `1`
> > * max: `64`

> HealthCheckSourceStatus -> (string) [required]

> > The current status of the health check source. The health check source status can have one of the following values:

> > * `CREATE_PENDING` - Route 53 accepted the request to create the source and hasn’t started creating it. You can’t use the source in a health check until its status is `CREATE_COMPLETED` .
> > * `CREATE_IN_PROGRESS` - Route 53 is creating the source. You can’t use the source in a health check until its status is `CREATE_COMPLETED` .
> > * `CREATE_COMPLETED` - The source is ready to use.
> > * `CREATE_FAILED` - Route 53 couldn’t create the source. `StatusReasonCode` and `StatusReason` explain why.
> > * `DELETE_PENDING` - Route 53 accepted the request to delete the source and hasn’t started deleting it.
> > * `DELETE_IN_PROGRESS` - Route 53 is deleting the source.
> > * `DELETE_COMPLETED` - Route 53 has deleted the source. You can’t retrieve a health check source in this status: `GetHealthCheckSource` returns `NoSuchHealthCheckSource` .
> > * `DELETE_FAILED` - Route 53 couldn’t delete the source. `StatusReasonCode` and `StatusReason` explain why.

> > If the status is `CREATE_FAILED` , fix the cause that `StatusReasonCode` indicates, and then either retry `CreateHealthCheckSource` with the same `CallerReference` and settings, or delete the source and create a new one. If the status is `DELETE_FAILED` , retry the `DeleteHealthCheckSource` request.

> > Possible values:

> > * `CREATE_PENDING`
> > * `CREATE_IN_PROGRESS`
> > * `CREATE_COMPLETED`
> > * `CREATE_FAILED`
> > * `DELETE_PENDING`
> > * `DELETE_IN_PROGRESS`
> > * `DELETE_COMPLETED`
> > * `DELETE_FAILED`

> HealthCheckSourceConfig -> (structure) [required]

> > The virtual private cloud (VPC), subnets, and security groups for the health check source.

> > VpcId -> (string) [required]

> > > The ID of the virtual private cloud (VPC) that contains the subnets for the health check source. All subnets in `SubnetConfigurationList` must belong to this VPC.

> > > Constraints:

> > > * max: `1024`

> > SubnetConfigurationList -> (list) [required]

> > > A complex type that contains two or three `SubnetConfiguration` elements, one in each Availability Zone that Route 53 uses for private endpoint health checks in the Amazon Web Services Region. The Availability Zones must be distinct. Route 53 creates network interfaces in each subnet and sends health check requests from all of them.

> > > Constraints:

> > > * min: `2`
> > > * max: `3`

> > > (structure)

> > > > A complex type that identifies one subnet for a health check source and the security groups that Route 53 associates with the network interfaces that it creates in that subnet.

> > > > SubnetId -> (string) [required]

> > > > > The ID of the subnet that Route 53 uses to send health check requests.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `64`

> > > > AvailabilityZoneId -> (string) [required]

> > > > > The ID of the Availability Zone that contains the subnet, for example `use1-az1` . Specify the Availability Zone ID, not the Availability Zone name.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `64`

> > > > SecurityGroupIdList -> (list) [required]

> > > > > The IDs of the security groups in the same virtual private cloud (VPC) to associate with the network interfaces that Route 53 creates in this subnet. The security groups must allow outbound traffic to the endpoints that the health checks monitor.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `10`

> > > > > (string)

> > > > > > Constraints:

> > > > > > * min: `1`
> > > > > > * max: `64`

> StatusReasonCode -> (string)

> > A code that indicates why the health check source has a status of `CREATE_FAILED` or `DELETE_FAILED` . Route 53 returns this member only when the status is one of those values. The code can have one of the following values:

> > * `INSUFFICIENT_SUBNET_IPS` - One of the specified subnets doesn’t have enough free private IP addresses. Check the available IP addresses in each subnet, and delete network interfaces that you don’t need.
> > * `EC2_LIMIT_EXCEEDED` - Your account reached an Amazon virtual private cloud (VPC) quota for network interfaces or security groups. Delete network interfaces that you don’t need, specify fewer security groups, or request a quota increase.
> > * `INVALID_SUBNET` - One of the specified subnets doesn’t exist or isn’t valid, or an `AvailabilityZoneId` doesn’t match the Availability Zone of its subnet. Check that each subnet ID is correct, that the subnet exists, and that each `AvailabilityZoneId` matches its subnet.
> > * `INVALID_SECURITY_GROUP` - One of the specified security groups doesn’t exist or isn’t valid. Check that each security group ID is correct and that the security group exists.
> > * `INVALID_CONFIGURATION` - The combination of VPC, subnets, and security groups isn’t valid. Check that `VpcId` is correct and exists, that each subnet is in that VPC, and that the security groups for each subnet are in the same VPC as that subnet.
> > * `SLR_MISSING_OR_NOT_ASSUMABLE` - Route 53 couldn’t assume its service-linked role in your account. In IAM, check that the service-linked role for Route 53 private endpoint health checks exists and that no deletion task for it is in progress.
> > * `INTERNAL_ERROR` - Route 53 encountered an internal error. Contact Amazon Web Services Support and provide the health check source ID.

> > Possible values:

> > * `INSUFFICIENT_SUBNET_IPS`
> > * `EC2_LIMIT_EXCEEDED`
> > * `INVALID_SUBNET`
> > * `INVALID_SECURITY_GROUP`
> > * `INVALID_CONFIGURATION`
> > * `SLR_MISSING_OR_NOT_ASSUMABLE`
> > * `INTERNAL_ERROR`

> StatusReason -> (string)

> > A description of why the health check source has a status of `CREATE_FAILED` or `DELETE_FAILED` , and what you can do about it. The text corresponds to the value of `StatusReasonCode` . Route 53 returns this member only when `StatusReasonCode` is present.
