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 DescribeApplicationStatusChecks operation. 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:

Inheritance Hierarchy

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

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

Syntax

C#
public class DescribeApplicationStatusChecksRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The DescribeApplicationStatusChecksRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ApplicationStatusCheckIds System.Collections.Generic.List<System.String>

Gets and sets the property ApplicationStatusCheckIds.

The IDs of the application status checks to describe.

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

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

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 IncludeAll System.Nullable<System.Boolean>

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

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 specified application status checks.

To describe application status checks


var client = new AmazonEC2Client();
var response = client.DescribeApplicationStatusChecks(new DescribeApplicationStatusChecksRequest 
{
    ApplicationStatusCheckIds = new List<string> {
        "asc-0123456789abcdef0"
    }
});

List<ApplicationStatusCheckResponseObject> applicationStatusChecks = response.ApplicationStatusChecks;

            

This example uses a filter to describe application status checks included in aggregation.

To describe application status checks using filters


var client = new AmazonEC2Client();
var response = client.DescribeApplicationStatusChecks(new DescribeApplicationStatusChecksRequest 
{
    Filters = new List<Filter> {
        new Filter {
            Name = "aggregation",
            Values = new List<string> {
                "included"
            }
        }
    },
    MaxResults = 10
});

List<ApplicationStatusCheckResponseObject> applicationStatusChecks = response.ApplicationStatusChecks;

            

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