NetworkFirewall / Client / list_container_associations

list_container_associations

NetworkFirewall.Client.list_container_associations(**kwargs)

Retrieves the metadata for the container associations that you have defined. You can optionally page through results.

See also: AWS API Documentation

Request Syntax

response = client.list_container_associations(
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • MaxResults (integer) – The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

  • NextToken (string) – When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Return type:

dict

Returns:

Response Syntax

{
    'ContainerAssociations': [
        {
            'Arn': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ContainerAssociations (list) –

      The container association metadata objects.

      • (dict) –

        High-level information about a container association, returned by the ListContainerAssociations operation. You can use this information to retrieve the full details of a container association using DescribeContainerAssociation.

        • Arn (string) –

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

        • Name (string) –

          The descriptive name of the container association.

    • NextToken (string) –

      When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Exceptions

  • NetworkFirewall.Client.exceptions.InvalidRequestException

  • NetworkFirewall.Client.exceptions.InternalServerError

  • NetworkFirewall.Client.exceptions.ThrottlingException