describe_application_status_checks¶
Operation¶
describe_application_status_checks
async
¶
describe_application_status_checks(request: DescribeApplicationStatusChecksInput | DescribeApplicationStatusChecksInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeApplicationStatusChecksOutput
describe_application_status_checks(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeApplicationStatusChecksInputDict]) -> DescribeApplicationStatusChecksOutput
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
DescribeApplicationStatusto see the actual health status of instances.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeApplicationStatusChecksOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeApplicationStatusChecksInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeApplicationStatusChecksInput structure.
Attributes¶
application_status_check_ids
class-attribute
instance-attribute
¶
The IDs of the application status checks to describe.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
filters
class-attribute
instance-attribute
¶
The filters.
aggregation-- The aggregation setting. Valid values:includedandexcluded.
include_all
class-attribute
instance-attribute
¶
include_all: bool | None = ...
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.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
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.
Dictionaries¶
DescribeApplicationStatusChecksInputDict
¶
Bases: TypedDict
Dictionary form of DescribeApplicationStatusChecksInput.
Attributes¶
application_status_check_ids
instance-attribute
¶
The IDs of the application status checks to describe.
dry_run
instance-attribute
¶
dry_run: bool | None
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.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
The filters.
aggregation-- The aggregation setting. Valid values:includedandexcluded.
include_all
instance-attribute
¶
include_all: bool | None
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.
max_results
instance-attribute
¶
max_results: int | None
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.
Output¶
DescribeApplicationStatusChecksOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeApplicationStatusChecksOutput structure.
Attributes¶
application_status_checks
class-attribute
instance-attribute
¶
application_status_checks: list[ApplicationStatusCheckResponseObject] | None = ...
Information about the application status checks.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to include in another request to get the next page of items.
This value is null when there are no more items to return.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.