Request Parameters Response Elements Errors Examples See Also

DescribeApplicationStatus

Describes the application status for the specified instances. Returns the aggregated application health status for each instance. The following rules apply:

The instance-level status is derived from all application status checks with the aggregation setting set to included.
Use DescribeApplicationStatusChecks to view the configuration of individual checks.
Use EnableApplicationStatusCheckSuppression to temporarily suppress health check results from affecting the instance-level status.

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.

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.

tag:<key> - The key/value combination of a tag assigned to the instance. Use the tag key in the filter name and the tag value as the filter value.
tag-key - The key of a tag assigned to the instance. Use this filter to find all instances that have a tag with a specific key, regardless of the tag value.
tag-value - The value of a tag assigned to the instance. Use this filter to find all instances that have a tag with a specific value, regardless of the tag key.
instance-id - The ID of the instance.
availability-zone - The Availability Zone of the instance.

Type: Array of Filter objects

Required: No

InstanceId.N

The IDs of the instances for which to describe application status.

Type: Array of strings

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

applicationStatusesResponseType

The application statuses for the specified instances.

Type: ApplicationStatusesResponseType object

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 for instances

This example describes the application status for the specified instance.

Sample Request


https://ec2.amazonaws.com/?Action=DescribeApplicationStatus
&InstanceId.1=i-0123456789abcdef0
&AUTHPARAMS

Sample Response


<DescribeApplicationStatusResult xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
    <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
    <applicationStatusesResponseType>
        <instanceSet>
            <item>
                <instanceId>i-0123456789abcdef0</instanceId>
                <applicationStatus>
                    <status>ok</status>
                </applicationStatus>
            </item>
        </instanceSet>
    </applicationStatusesResponseType>
</DescribeApplicationStatusResult>