Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeContainerAssociation

Retrieves the configuration and status of a container association.

Request Syntax


{
   "ContainerAssociationArn": "string",
   "ContainerAssociationName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ContainerAssociationArn

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

You must specify the ARN or the name, and you can specify both.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws.*

Required: No

ContainerAssociationName

The descriptive name of the container association.

You must specify the ARN or the name, and you can specify both.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-]+$

Required: No

Response Syntax


{
   "ContainerAssociationArn": "string",
   "ContainerAssociationName": "string",
   "ContainerMonitoringConfigurations": [ 
      { 
         "AttributeFilters": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "ClusterArn": "string"
      }
   ],
   "Description": "string",
   "ResolvedCidrCount": number,
   "Status": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Type": "string",
   "UpdateToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ContainerAssociationArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws.*

ContainerAssociationName

The descriptive name of the container association.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-]+$

ContainerMonitoringConfigurations

The monitoring configurations for the container association.

Type: Array of ContainerMonitoringConfiguration objects

Description

A description of the container association.

Type: String

Length Constraints: Maximum length of 512.

Pattern: ^.*$

ResolvedCidrCount

The number of CIDR blocks resolved from the monitored containers.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000000.

Status

The current status of the container association.

Type: String

Valid Values: ACTIVE | CREATING | DELETING

Tags

The key:value pairs to associate with the resource.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Type

The container type. Valid values:

ECS - Amazon Elastic Container Service
EKS - Amazon Elastic Kubernetes Service

Type: String

Valid Values: ECS | EKS

UpdateToken

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.

To make changes to the container association, you provide the token in your request. Network Firewall uses the token to ensure that the container association hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the container association again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServerError

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

HTTP Status Code: 500

InvalidRequestException

The operation failed because of a problem with your request. Examples include:

You specified an unsupported parameter name or value.
You tried to update a property with a value that isn't among the available types.
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

HTTP Status Code: 400

ResourceNotFoundException

Unable to locate a resource using the parameters that you provided.

HTTP Status Code: 400

ThrottlingException

Unable to process the request due to throttling limitations.

HTTP Status Code: 400