# ListContainerGroupDefinitions
<a name="API_ListContainerGroupDefinitions"></a>

 **This API works with the following fleet types:** Container

Retrieves container group definitions for the AWS account and AWS Region. Use the pagination parameters to retrieve results in a set of sequential pages.

This operation returns only the latest version of each definition. To retrieve all versions of a container group definition, use [ListContainerGroupDefinitionVersions](https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListContainerGroupDefinitionVersions.html).

 **Request options:** 
+ Retrieve the most recent versions of all container group definitions. 
+ Retrieve the most recent versions of all container group definitions, filtered by type. Specify the container group type to filter on. 

 **Results:** 

If successful, this operation returns the complete properties of a set of container group definition versions that match the request.

**Note**  
This operation returns the list of container group definitions in no particular order. 

## Request Syntax
<a name="API_ListContainerGroupDefinitions_RequestSyntax"></a>

```
{
   "ContainerGroupType": "string",
   "Limit": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListContainerGroupDefinitions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [ContainerGroupType](#API_ListContainerGroupDefinitions_RequestSyntax) **   <a name="gameliftservers-ListContainerGroupDefinitions-request-ContainerGroupType"></a>
The type of container group to retrieve. Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.  
Type: String  
Valid Values: `GAME_SERVER | PER_INSTANCE`   
Required: No

 ** [Limit](#API_ListContainerGroupDefinitions_RequestSyntax) **   <a name="gameliftservers-ListContainerGroupDefinitions-request-Limit"></a>
The maximum number of results to return. Use this parameter with `NextToken` to get results as a set of sequential pages.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListContainerGroupDefinitions_RequestSyntax) **   <a name="gameliftservers-ListContainerGroupDefinitions-request-NextToken"></a>
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListContainerGroupDefinitions_ResponseSyntax"></a>

```
{
   "ContainerGroupDefinitions": [ 
      { 
         "ContainerGroupDefinitionArn": "string",
         "ContainerGroupType": "string",
         "CreationTime": number,
         "GameServerContainerDefinition": { 
            "ContainerName": "string",
            "DependsOn": [ 
               { 
                  "Condition": "string",
                  "ContainerName": "string"
               }
            ],
            "EnvironmentOverride": [ 
               { 
                  "Name": "string",
                  "Value": "string"
               }
            ],
            "ImageUri": "string",
            "MountPoints": [ 
               { 
                  "AccessLevel": "string",
                  "ContainerPath": "string",
                  "InstancePath": "string"
               }
            ],
            "PortConfiguration": { 
               "ContainerPortRanges": [ 
                  { 
                     "FromPort": number,
                     "Protocol": "string",
                     "ToPort": number
                  }
               ]
            },
            "ResolvedImageDigest": "string",
            "ServerSdkVersion": "string"
         },
         "Name": "string",
         "OperatingSystem": "string",
         "Status": "string",
         "StatusReason": "string",
         "SupportContainerDefinitions": [ 
            { 
               "ContainerName": "string",
               "DependsOn": [ 
                  { 
                     "Condition": "string",
                     "ContainerName": "string"
                  }
               ],
               "EnvironmentOverride": [ 
                  { 
                     "Name": "string",
                     "Value": "string"
                  }
               ],
               "Essential": boolean,
               "HealthCheck": { 
                  "Command": [ "string" ],
                  "Interval": number,
                  "Retries": number,
                  "StartPeriod": number,
                  "Timeout": number
               },
               "ImageUri": "string",
               "MemoryHardLimitMebibytes": number,
               "MountPoints": [ 
                  { 
                     "AccessLevel": "string",
                     "ContainerPath": "string",
                     "InstancePath": "string"
                  }
               ],
               "PortConfiguration": { 
                  "ContainerPortRanges": [ 
                     { 
                        "FromPort": number,
                        "Protocol": "string",
                        "ToPort": number
                     }
                  ]
               },
               "ResolvedImageDigest": "string",
               "Vcpu": number
            }
         ],
         "TotalMemoryLimitMebibytes": number,
         "TotalVcpuLimit": number,
         "VersionDescription": "string",
         "VersionNumber": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListContainerGroupDefinitions_ResponseElements"></a>

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

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

 ** [ContainerGroupDefinitions](#API_ListContainerGroupDefinitions_ResponseSyntax) **   <a name="gameliftservers-ListContainerGroupDefinitions-response-ContainerGroupDefinitions"></a>
A result set of container group definitions that match the request.  
Type: Array of [ContainerGroupDefinition](API_ContainerGroupDefinition.md) objects

 ** [NextToken](#API_ListContainerGroupDefinitions_ResponseSyntax) **   <a name="gameliftservers-ListContainerGroupDefinitions-response-NextToken"></a>
A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_ListContainerGroupDefinitions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceException **   
The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.  
HTTP Status Code: 500

 ** InvalidRequestException **   
One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.  
HTTP Status Code: 400

 ** UnauthorizedException **   
The client failed authentication. Clients should not retry such requests.  
HTTP Status Code: 400

 ** UnsupportedRegionException **   
The requested operation is not supported in the Region specified.  
HTTP Status Code: 400

## Examples
<a name="API_ListContainerGroupDefinitions_Examples"></a>

### Retrieve all game server container group definitions
<a name="API_ListContainerGroupDefinitions_Example_1"></a>

This example retrieves all container group definitions of type `GAME_SERVER`. It uses the pagination parameters to retrieve two definitions at a time. The response includes a `NextToken`, which indicates that there are still more results to retrieve.

HTTP requests are authenticated using an [AWS Signature Version 4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) signature in the `Authorization` header field.

#### Sample Request
<a name="API_ListContainerGroupDefinitions_Example_1_Request"></a>

```
{
    "ContainerGroupType": "GAME_SERVER",
    "Limit": 2
}
```

#### Sample Response
<a name="API_ListContainerGroupDefinitions_Example_1_Response"></a>

```
{
  "ContainerGroupDefinitions": [ 
    {
      "ContainerGroupDefinitionArn": "arn:aws:gamelift:us-west-2:111122223333:containergroupdefinition/MyAdventureGameContainerGroup:3",
      "ContainerGroupType": "GAME_SERVER",
      "CreationTime": 1496365885.44,
      "GameServerContainerDefinition": { 
        "ContainerName": "MyAdventureGameContainer",
        "ImageUri": "111122223333.dkr.ecr.us-west-2.amazonaws.com/MyAdventureGameContainerImage",
        "PortConfiguration": { 
          "ContainerPortRanges": [ 
            { 
              "FromPort": 35000,
              "Protocol": "TCP",
              "ToPort": 40000
            }
          ]
        },
        "ResolvedImageDigest": "sha256:0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
        "ServerSdkVersion": "5.2.0"
      }
      "Name": "MyAdventureGameContainerGroup",
      "OperatingSystem": "AMAZON_LINUX_2023",
      "Status": "READY",
      "TotalMemoryLimitMebibytes": 1024,
      "TotalVcpuLimit": 1,
      "VersionNumber": "3"
    },
    {
      "ContainerGroupDefinitionArn": "arn:aws:gamelift:us-west-2:111122223333:containergroupdefinition/MyRPGGameContainerGroup:1",
      "ContainerGroupType": "GAME_SERVER",
      "CreationTime": 1496365892.11,
      "GameServerContainerDefinition": { 
        "ContainerName": "MyRPGGameContainer",
        "ImageUri": "111122223333.dkr.ecr.us-west-2.amazonaws.com/MyRPGGameContainerImage",
        "PortConfiguration": { 
          "ContainerPortRanges": [ 
            { 
              "FromPort": 35000,
              "Protocol": "TCP",
              "ToPort": 40000
            }
          ]
        },
        "ResolvedImageDigest": "sha256:0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
        "ServerSdkVersion": "5.2.0"
      }
      "Name": "MyRPGGameContainerGroup",
      "OperatingSystem": "AMAZON_LINUX_2023",
      "Status": "COPYING",
      "TotalMemoryLimitMebibytes": 1024,
      "TotalVcpuLimit": 1,
      "VersionNumber": "1"
    },
  ],
  "NextToken": "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE1"
}
```

## See Also
<a name="API_ListContainerGroupDefinitions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/gamelift-2015-10-01/ListContainerGroupDefinitions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/gamelift-2015-10-01/ListContainerGroupDefinitions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/gamelift-2015-10-01/ListContainerGroupDefinitions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/gamelift-2015-10-01/ListContainerGroupDefinitions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/gamelift-2015-10-01/ListContainerGroupDefinitions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/gamelift-2015-10-01/ListContainerGroupDefinitions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/gamelift-2015-10-01/ListContainerGroupDefinitions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/gamelift-2015-10-01/ListContainerGroupDefinitions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/gamelift-2015-10-01/ListContainerGroupDefinitions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/gamelift-2015-10-01/ListContainerGroupDefinitions)