EC2 / Client / describe_application_status_checks

describe_application_status_checks¶

EC2.Client.describe_application_status_checks(**kwargs)¶

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:

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

Request Syntax

response = client.describe_application_status_checks(
    ApplicationStatusCheckIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    IncludeAll=True|False,
    DryRun=True|False
)

Parameters:

ApplicationStatusCheckIds (list) –
The IDs of the application status checks to describe.
- (string) –
Filters (list) –
The filters.
- aggregation – The aggregation setting. Valid values: included and excluded.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  
  If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - Name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) –
    
    The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    - (string) –
MaxResults (integer) – 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 (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
IncludeAll (boolean) – 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 (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationStatusChecks': [
        {
            'ApplicationStatusCheckId': 'string',
            'Aggregation': 'included'|'excluded',
            'HealthCheckPaths': [
                {
                    'Source': {
                        'SubnetId': 'string',
                        'SecurityGroupId': 'string'
                    },
                    'Destinations': [
                        {
                            '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': datetime(2015, 1, 1),
            'TargetTagAssociations': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'CreationTime': datetime(2015, 1, 1),
            'ModifyTime': datetime(2015, 1, 1),
            'DeletionTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- ApplicationStatusChecks (list) –
  
  Information about the application status checks.
  - (dict) –
    
    Describes an application status check.
    - ApplicationStatusCheckId (string) –
      
      The ID of the application status check.
    - Aggregation (string) –
      
      The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status. When set to excluded, the check runs independently and does not affect the instance-level status.
    - HealthCheckPaths (list) –
      
      The health check paths for the application status check.
      - (dict) –
        
        Describes a health check path for an application status check.
        
        Source (dict) –
        
        The source for the health check path.
        
        SubnetId (string) –
        
        The ID of the subnet for the source.
        
        SecurityGroupId (string) –
        
        The ID of the security group for the source.
        
        Destinations (list) –
        
        The destinations for the health check path.
        
        (dict) –
        
        Describes a destination for a health check path.
        
        SubnetId (string) –
        
        The ID of the subnet for the destination.
        
        SecurityGroupId (string) –
        
        The ID of the security group for the destination.
    - Protocol (string) –
      
      The protocol used for the health check.
    - Port (integer) –
      
      The port used for the health check.
    - Path (string) –
      
      The URL path used for the health check HTTP request.
    - DeviceIndex (integer) –
      
      The index of the network device used for the health check. The value is greater than or equal to 0.
    - IpVersion (string) –
      
      The IP version used for the health check.
    - IpScope (string) –
      
      The IP scope used for the health check.
    - Interval (integer) –
      
      The interval, in seconds, between health checks. Valid value: 60.
    - Timeout (integer) –
      
      The amount of time, in seconds, to wait for a health check response. Valid values: 1 to 30.
    - FailureThreshold (integer) –
      
      The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.
    - SuccessThreshold (integer) –
      
      The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.
    - StatusCodeMatcher (string) –
      
      The comma-separated list of individual HTTP status codes or ranges that indicate a successful health check response.
    - InitializationGracePeriodSeconds (integer) –
      
      The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.
    - LastUpdatedAt (datetime) –
      
      The date and time when the application status check was last updated.
    - TargetTagAssociations (list) –
      
      The tags associated with the application status check. Instances with these tags are automatically monitored by this check.
      - (dict) –
        
        Describes a tag key-value pair for an application status check association.
        
        Key (string) –
        
        The key of the tag.
        
        Value (string) –
        
        The value of the tag.
    - Tags (list) –
      
      The tags assigned to the application status check.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
    - CreationTime (datetime) –
      
      The date and time when the application status check was created.
    - ModifyTime (datetime) –
      
      The date and time when the application status check was last modified.
    - DeletionTime (datetime) –
      
      The date and time when the application status check was deleted.
- NextToken (string) –
  
  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.