AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DescribeApplicationStatus operation. Describes the application status for the specified instances. Returns the aggregated application health status for each instance. The following rules apply:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.DescribeApplicationStatusRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeApplicationStatusRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The DescribeApplicationStatusRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property DryRun System.Nullable<System.Boolean>

Gets and sets the property 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.

Public Property Filters System.Collections.Generic.List<Amazon.EC2.Model.Filter>

Gets and sets the property Filters.

The filters.

  • availability-zone-id – The ID of the Availability Zone.

  • status – The instance-level application status. For valid values and their meanings, see ApplicationStatus.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property InstanceIds System.Collections.Generic.List<System.String>

Gets and sets the property InstanceIds.

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

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property MaxResults System.Nullable<System.Int32>

Gets and sets the property 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.

Public Property NextToken System.String

Gets and sets the property NextToken.

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

Examples

This example describes the application status for the specified instance.

To describe application status for instances


var client = new AmazonEC2Client();
var response = client.DescribeApplicationStatus(new DescribeApplicationStatusRequest 
{
    InstanceIds = new List<string> {
        "i-0123456789abcdef0"
    }
});

ApplicationStatusesResponseType applicationStatuses = response.ApplicationStatuses;

            

This example uses a filter to describe impaired application status in a specific Availability Zone.

To describe application status using filters


var client = new AmazonEC2Client();
var response = client.DescribeApplicationStatus(new DescribeApplicationStatusRequest 
{
    Filters = new List<Filter> {
        new Filter {
            Name = "availability-zone-id",
            Values = new List<string> {
                "use1-az1"
            }
        },
        new Filter {
            Name = "status",
            Values = new List<string> {
                "impaired"
            }
        }
    },
    MaxResults = 10
});

ApplicationStatusesResponseType applicationStatuses = response.ApplicationStatuses;

            

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer