Describes application status checks, including configuration details such as protocol, port, path, thresholds, and associations¶

Description¶

Describes application status checks, including configuration details such as protocol, port, path, thresholds, and associations. Results are paginated. Use the NextToken parameter to retrieve additional results. The following rules apply:

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

Usage¶

ec2_describe_application_status_checks(ApplicationStatusCheckIds,
  Filters, MaxResults, NextToken, IncludeAll, DryRun)

Arguments¶

ApplicationStatusCheckIds

The IDs of the application status checks to describe.

Filters

The filters.

aggregation – The aggregation setting. Valid values: included and excluded.
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.

NextToken

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

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.

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.

Value¶

A list with the following syntax:

list(
  ApplicationStatusChecks = list(
    list(
      ApplicationStatusCheckId = "string",
      Aggregation = "included"|"excluded",
      HealthCheckPaths = list(
        list(
          Source = list(
            SubnetId = "string",
            SecurityGroupId = "string"
          ),
          Destinations = list(
            list(
              SubnetId = "string",
              SecurityGroupId = "string"
            )
          )
        )
      ),
      Protocol = "http"|"https",
      Port = 123,
      Path = "string",
      DeviceIndex = 123,
      IpVersion = "ipv4"|"ipv6",
      IpScope = "private",
      Interval = 123,
      Timeout = 123,
      FailureThreshold = 123,
      SuccessThreshold = 123,
      StatusCodeMatcher = "string",
      InitializationGracePeriodSeconds = 123,
      LastUpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      TargetTagAssociations = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      ModifyTime = as.POSIXct(
        "2015-01-01"
      ),
      DeletionTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_application_status_checks(
  ApplicationStatusCheckIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  IncludeAll = TRUE|FALSE,
  DryRun = TRUE|FALSE
)