GameLift / Client / describe_container_group_definition

describe_container_group_definition

GameLift.Client.describe_container_group_definition(**kwargs)

This operation is used with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves the properties of a container group definition, including all container definitions in the group.

To retrieve a container group definition, provide a resource identifier. If successful, this operation returns the complete properties of the container group definition.

Learn more

• Manage a container group definition

See also: AWS API Documentation

Request Syntax

response = client.describe_container_group_definition(
    Name='string'
)

Parameters:

Name (string) –

[REQUIRED]

The unique identifier for the container group definition to retrieve properties for. You can use either the Name or ARN value.

Return type:

dict

Returns:

Response Syntax

{
    'ContainerGroupDefinition': {
        'ContainerGroupDefinitionArn': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'OperatingSystem': 'AMAZON_LINUX_2023',
        'Name': 'string',
        'SchedulingStrategy': 'REPLICA'|'DAEMON',
        'TotalMemoryLimit': 123,
        'TotalCpuLimit': 123,
        'ContainerDefinitions': [
            {
                'ContainerName': 'string',
                'ImageUri': 'string',
                'ResolvedImageDigest': 'string',
                'MemoryLimits': {
                    'SoftLimit': 123,
                    'HardLimit': 123
                },
                'PortConfiguration': {
                    'ContainerPortRanges': [
                        {
                            'FromPort': 123,
                            'ToPort': 123,
                            'Protocol': 'TCP'|'UDP'
                        },
                    ]
                },
                'Cpu': 123,
                'HealthCheck': {
                    'Command': [
                        'string',
                    ],
                    'Interval': 123,
                    'Timeout': 123,
                    'Retries': 123,
                    'StartPeriod': 123
                },
                'Command': [
                    'string',
                ],
                'Essential': True|False,
                'EntryPoint': [
                    'string',
                ],
                'WorkingDirectory': 'string',
                'Environment': [
                    {
                        'Name': 'string',
                        'Value': 'string'
                    },
                ],
                'DependsOn': [
                    {
                        'ContainerName': 'string',
                        'Condition': 'START'|'COMPLETE'|'SUCCESS'|'HEALTHY'
                    },
                ]
            },
        ],
        'Status': 'READY'|'COPYING'|'FAILED',
        'StatusReason': 'string'
    }
}

Response Structure

• (dict) –

  • ContainerGroupDefinition (dict) –

    The properties of the requested container group definition resource.

    • ContainerGroupDefinitionArn (string) –

      The Amazon Resource Name ( ARN) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift:<region>::containergroupdefinition/[container group definition name].

    • CreationTime (datetime) –

      A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

    • OperatingSystem (string) –

      The platform required for all containers in the container group definition.

    • Name (string) –

      A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region.

    • SchedulingStrategy (string) –

      The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.

    • TotalMemoryLimit (integer) –

      The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources.

      You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must meet the following requirements:

      • Equal to or greater than the sum of all container-specific soft memory limits in the group.

      • Equal to or greater than any container-specific hard limits in the group.

      For more details on memory allocation, see the Container fleet design guide.

    • TotalCpuLimit (integer) –

      The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).

      You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.

      For more details on memory allocation, see the Container fleet design guide.

    • ContainerDefinitions (list) –

      The set of container definitions that are included in the container group.

      • (dict) –

        This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

        Describes a container in a container fleet, the resources available to the container, and the commands that are run when the container starts. Container properties can’t be updated. To change a property, create a new container group definition. See also ContainerDefinitionInput.

        Part of: ContainerGroupDefinition

        Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions

        • ContainerName (string) –

          The container definition identifier. Container names are unique within a container group definition.

        • ImageUri (string) –

          The URI to the image that $short; copied and deployed to a container fleet. For a more specific identifier, see ResolvedImageDigest.

        • ResolvedImageDigest (string) –

          A unique and immutable identifier for the container image that is deployed to a container fleet. The digest is a SHA 256 hash of the container image manifest.

        • MemoryLimits (dict) –

          The amount of memory that Amazon GameLift makes available to the container. If memory limits aren’t set for an individual container, the container shares the container group’s total memory allocation.

          Related data type: ContainerGroupDefinition$TotalMemoryLimit

          • SoftLimit (integer) –

            The amount of memory that is reserved for a container. When the container group’s shared memory is under contention, the system attempts to maintain the container memory usage at this soft limit. However, the container can use more memory when needed, if available. This property is similar to the Amazon ECS container definition parameter memoryreservation (Amazon Elastic Container Service Developer Guide).

          • HardLimit (integer) –

            The maximum amount of memory that the container can use. If a container attempts to exceed this limit, the container is stopped. This property is similar to the Amazon ECS container definition parameter memory in the Amazon Elastic Container Service Developer Guide.

        • PortConfiguration (dict) –

          Defines the ports that are available to assign to processes in the container. For example, a game server process requires a container port to allow game clients to connect to it. Container ports aren’t directly accessed by inbound traffic. Amazon GameLift maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet’s ConnectionPortRange.

          • ContainerPortRanges (list) –

            Specifies one or more ranges of ports on a container. These ranges must not overlap.

            • (dict) –

              This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

              A set of one or more port numbers that can be opened on the container.

              Part of: ContainerPortConfiguration

              • FromPort (integer) –

                A starting value for the range of allowed port numbers.

              • ToPort (integer) –

                An ending value for the range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.

              • Protocol (string) –

                The network protocol that these ports support.

        • Cpu (integer) –

          The number of CPU units that are reserved for the container. Note: 1 vCPU unit equals 1024 CPU units. If no resources are reserved, the container shares the total CPU limit for the container group.

          Related data type: ContainerGroupDefinition$TotalCpuLimit

        • HealthCheck (dict) –

          A configuration for a non-terminal health check. A container, which automatically restarts if it stops functioning, also restarts if it fails this health check. If an essential container in the daemon group fails a health check, the entire container group is restarted. The essential container in the replica group doesn’t use this health check mechanism, because the Amazon GameLift Agent automatically handles the task.

          • Command (list) –

            A string array that specifies the command that the container runs to determine if it’s healthy.

            • (string) –

          • Interval (integer) –

            The time period (in seconds) between each health check.

          • Timeout (integer) –

            The time period (in seconds) to wait for a health check to succeed before a failed health check is counted.

          • Retries (integer) –

            The number of times to retry a failed health check before the container is considered unhealthy. The first run of the command does not count as a retry.

          • StartPeriod (integer) –

            The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.

        • Command (list) –

          A command that’s passed to the container on startup. Each argument for the command is an additional string in the array. See the ContainerDefinition::command parameter in the Amazon Elastic Container Service API reference.

          • (string) –

        • Essential (boolean) –

          Indicates whether the container is vital to the container group. If an essential container fails, the entire container group is restarted.

        • EntryPoint (list) –

          The entry point that’s passed to the container on startup. If there are multiple arguments, each argument is an additional string in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API Reference.

          • (string) –

        • WorkingDirectory (string) –

          The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API Reference.

        • Environment (list) –

          A set of environment variables that’s passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.

          • (dict) –

            This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

            An environment variable to set inside a container, in the form of a key-value pair.

            Related data type: ContainerDefinition$Environment

            • Name (string) –

              The environment variable name.

            • Value (string) –

              The environment variable value.

        • DependsOn (list) –

          Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. A container might have dependencies on multiple containers.

          • (dict) –

            This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

            A container’s dependency on another container in the same container group. The dependency impacts how the dependent container is able to start or shut down based the status of the other container.

            For example, ContainerA is configured with the following dependency: a START dependency on ContainerB. This means that ContainerA can’t start until ContainerB has started. It also means that ContainerA must shut down before ContainerB.

            Part of: ContainerDefinition

            • ContainerName (string) –

              A descriptive label for the container definition that this container depends on.

            • Condition (string) –

              The condition that the dependency container must reach before the dependent container can start. Valid conditions include:

              • START - The dependency container must have started.

              • COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can’t be an essential container.

              • SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can’t be an essential container.

              • HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.

    • Status (string) –

      Current status of the container group definition resource. Values include:

      • COPYING – Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can’t be used to create a container fleet.

      • READY – Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

      • FAILED – Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

    • StatusReason (string) –

      Additional information about a container group definition that’s in FAILED status. Possible reasons include:

      • An internal issue prevented Amazon GameLift from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain.

      • An access-denied message means that you don’t have permissions to access the container image on ECR. See IAM permission examples for help setting up required IAM permissions for Amazon GameLift.

      • The ImageUri value for at least one of the containers in the container group definition was invalid or not found in the current Amazon Web Services account.

      • At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift endpoints and quotas.

      • At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.

Exceptions

• GameLift.Client.exceptions.UnauthorizedException

• GameLift.Client.exceptions.InvalidRequestException

• GameLift.Client.exceptions.NotFoundException

• GameLift.Client.exceptions.InternalServiceException

• GameLift.Client.exceptions.UnsupportedRegionException