AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ec2 ]

describe-application-status-checks

Description

Describes one or more application status checks. Returns configuration details for your application status checks, including protocol, port, path, thresholds, and associations. The following rules apply:

  • If you do not specify any application status check IDs, all checks in your account are returned.
  • Use DescribeApplicationStatus to see the actual health status of instances.

See also: AWS API Documentation

Synopsis

  describe-application-status-checks
[--application-status-check-ids <value>]
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
[--include-all | --no-include-all]
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--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>]
[--v2-debug]

Options

--application-status-check-ids (list)

The IDs of the application status checks to describe.

(string)

Syntax:

"string" "string" ...

--filters (list)

The filters.

  • aggregation – The aggregation setting. Valid values: included and excluded .

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.

For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide .

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--max-results (integer)

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination .

--next-token (string)

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

--include-all | --no-include-all (boolean)

Specifies whether to include recently deleted application status checks that remain available during the deletion grace period. If you omit this parameter or set it to false , the response includes only active checks.

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

ApplicationStatusChecks -> (list)

Information about the application status checks.

(structure)

Describes an application status check.

ApplicationStatusCheckId -> (string)

The ID of the application status check.

Aggregation -> (string)

The aggregation setting for the application status check. When set to included , the result of this check contributes to the instance-level application status. When set to excluded , the check runs independently and does not affect the instance-level status.

HealthCheckPaths -> (list)

The health check paths for the application status check.

(structure)

Describes a health check path for an application status check.

Source -> (structure)

The source for the health check path.

SubnetId -> (string)

The ID of the subnet for the source.

SecurityGroupId -> (string)

The ID of the security group for the source.

Destinations -> (list)

The destinations for the health check path.

(structure)

Describes a destination for a health check path.

SubnetId -> (string)

The ID of the subnet for the destination.

SecurityGroupId -> (string)

The ID of the security group for the destination.

Protocol -> (string)

The protocol used for the health check.

Port -> (integer)

The port used for the health check.

Path -> (string)

The URL path used for the health check HTTP request.

DeviceIndex -> (integer)

The index of the network device used for the health check. The value is greater than or equal to 0.

IpVersion -> (string)

The IP version used for the health check.

IpScope -> (string)

The IP scope used for the health check.

Interval -> (integer)

The interval, in seconds, between health checks. Valid value: 60.

Timeout -> (integer)

The amount of time, in seconds, to wait for a health check response. Valid values: 1 to 30.

FailureThreshold -> (integer)

The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.

SuccessThreshold -> (integer)

The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.

StatusCodeMatcher -> (string)

The comma-separated list of individual HTTP status codes or ranges that indicate a successful health check response.

InitializationGracePeriodSeconds -> (integer)

The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.

LastUpdatedAt -> (timestamp)

The date and time when the application status check was last updated.

TargetTagAssociations -> (list)

The tags associated with the application status check. Instances with these tags are automatically monitored by this check.

(structure)

Describes a tag key-value pair for an application status check association.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.

Tags -> (list)

The tags assigned to the application status check.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

CreationTime -> (timestamp)

The date and time when the application status check was created.

ModifyTime -> (timestamp)

The date and time when the application status check was last modified.

DeletionTime -> (timestamp)

The date and time when the application status check was deleted.

NextToken -> (string)

The token to include in another request to get the next page of items. This value is <code>null</code> when there are no more items to return.