Request Parameters Response Elements Errors Examples See Also

DescribeApplicationStatusChecks

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.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

ApplicationStatusCheckId.N

The IDs of the application status checks to describe.

Type: Array of strings

Required: No

DryRun

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.

Type: Boolean

Required: No

Filter.N

The filters.

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

Type: Array of Filter objects

Required: No

IncludeAll

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.

Type: Boolean

Required: No

MaxResults

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.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 100.

Required: No

NextToken

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

Type: String

Required: No

Response Elements

The following elements are returned by the service.

applicationStatusCheckSet

Information about the application status checks.

Type: Array of ApplicationStatusCheckResponseObject objects

nextToken

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.

Type: String

requestId

The ID of the request.

Type: String

Errors

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

Examples

To describe application status checks

This example describes the specified application status check.

Sample Request


https://ec2.amazonaws.com/?Action=DescribeApplicationStatusChecks
&ApplicationStatusCheckId.1=asc-0123456789abcdef0
&AUTHPARAMS

Sample Response


<DescribeApplicationStatusChecksResult xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
    <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
    <applicationStatusCheckSet>
        <item>
            <applicationStatusCheckId>asc-0123456789abcdef0</applicationStatusCheckId>
            <protocol>http</protocol>
            <port>80</port>
        </item>
    </applicationStatusCheckSet>
</DescribeApplicationStatusChecksResult>