NetworkFirewall / Client / describe_container_association

describe_container_association

NetworkFirewall.Client.describe_container_association(**kwargs)

Returns the properties of a container association.

See also: AWS API Documentation

Request Syntax

response = client.describe_container_association(
    ContainerAssociationName='string',
    ContainerAssociationArn='string'
)
Parameters:

  • ContainerAssociationName (string) – The descriptive name of the container association. You must specify the ARN or the name, and you can specify both.

  • ContainerAssociationArn (string) – The Amazon Resource Name (ARN) of the container association. You must specify the ARN or the name, and you can specify both.

Return type:

dict

Returns:

Response Syntax

{
    'ContainerAssociationName': 'string',
    'ContainerAssociationArn': 'string',
    'Description': 'string',
    'Type': 'ECS'|'EKS',
    'ContainerMonitoringConfigurations': [
        {
            'ClusterArn': 'string',
            'AttributeFilters': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'Status': 'ACTIVE'|'CREATING'|'DELETING',
    'ResolvedCidrCount': 123,
    'LastUpdatedTime': datetime(2015, 1, 1),
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'UpdateToken': 'string'
}

Response Structure

  • (dict) –

    • ContainerAssociationName (string) –

      The descriptive name of the container association.

    • ContainerAssociationArn (string) –

      The Amazon Resource Name (ARN) of the container association.

    • Description (string) –

      A description of the container association.

    • Type (string) –

      The type of container orchestration platform. Either ECS or EKS.

    • ContainerMonitoringConfigurations (list) –

      The container monitoring configurations for this container association.

      • (dict) –

        Defines a container cluster to monitor, along with optional attribute filters that narrow the scope of monitored containers within the cluster.

        • ClusterArn (string) –

          The Amazon Resource Name (ARN) of the container cluster to monitor.

        • AttributeFilters (list) –

          A list of key-value pairs that filter which containers within the cluster are monitored. Only containers that match the specified attributes are included.

          • (dict) –

            A key-value pair that defines a container attribute filter for a container monitoring configuration.

            • Key (string) –

              The key of the container attribute to filter on.

            • Value (string) –

              The value of the container attribute to filter on.

    • Status (string) –

      The current status of the container association.

    • ResolvedCidrCount (integer) –

      The number of CIDR blocks that have been resolved from the monitored containers for this container association.

    • LastUpdatedTime (datetime) –

      The last time that the container association was updated or resolved new container IP addresses.

    • Tags (list) –

      The key:value pairs associated with the resource.

      • (dict) –

        A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as “environment”) and the tag value represents a specific value within that category (such as “test,” “development,” or “production”). You can add up to 50 tags to each Amazon Web Services resource.

        • Key (string) –

          The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as “customer.” Tag keys are case-sensitive.

        • Value (string) –

          The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as “companyA” or “companyB.” Tag values are case-sensitive.

    • UpdateToken (string) –

      A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request.

Exceptions