EC2 / Client / describe_application_status_check_associations

describe_application_status_check_associations

EC2.Client.describe_application_status_check_associations(**kwargs)

Describes the associations for one or more application status checks. For more information, see Application status checks. To avoid timeouts and retrieve complete results, use the pagination parameters.

Note

The order of the elements in the response, including those within nested structures, might vary.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ApplicationStatusCheckIds (list) –

  The IDs of the application status checks for which to describe associations.

  • (string) –

• Filters (list) –

  The filters to use to limit the results.

  • association-type – The type of association. Valid values: tag and instance-id.

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

• 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

{
    'Associations': [
        {
            'ApplicationStatusCheckId': 'string',
            'AssociationType': 'tag'|'instance-id',
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'NextToken': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • Associations (list) –

    The associations for the specified application status checks.

    • (dict) –

      Information about an application status check association. Each item in the associationSet of a DescribeApplicationStatusCheckAssociations response is of this type.

      • ApplicationStatusCheckId (string) –

        The ID of the application status check.

      • AssociationType (string) –

        The type of target that the application status check is associated with. Possible values:

        • tag – The check applies to current and future instances with a matching tag key-value pair.

        • instance-id – The check applies to a specific instance.

      • Key (string) –

        The key for the association. This value is present only for tag-based associations, where it contains the tag key. For instance-based associations, this value is absent.

      • Value (string) –

        The value for the association target. For tag-based associations, this is the tag value. For instance-based associations, this is the instance ID (for example, i-0123456789abcdef0).

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

  • Tags (list) –

    The tags associated with the application status checks.

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