GameLift / Client / describe_container_fleet

describe_container_fleet#

GameLift.Client.describe_container_fleet(**kwargs)#

Retrieves the properties for a container fleet. When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

Request options

Get container fleet properties for a single fleet. Provide either the fleet ID or ARN value.

Results

If successful, a ContainerFleet object is returned. This object includes the fleet properties, including information about the most recent deployment.

Note

Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.

Request Syntax

response = client.describe_container_fleet(
    FleetId='string'
)

Parameters:

FleetId (string) –

[REQUIRED]

A unique identifier for the container fleet to retrieve. You can use either the fleet ID or ARN value.

Return type:

dict

Returns:

Response Syntax

{
    'ContainerFleet': {
        'FleetId': 'string',
        'FleetArn': 'string',
        'FleetRoleArn': 'string',
        'GameServerContainerGroupDefinitionName': 'string',
        'GameServerContainerGroupDefinitionArn': 'string',
        'PerInstanceContainerGroupDefinitionName': 'string',
        'PerInstanceContainerGroupDefinitionArn': 'string',
        'InstanceConnectionPortRange': {
            'FromPort': 123,
            'ToPort': 123
        },
        'InstanceInboundPermissions': [
            {
                'FromPort': 123,
                'ToPort': 123,
                'IpRange': 'string',
                'Protocol': 'TCP'|'UDP'
            },
        ],
        'GameServerContainerGroupsPerInstance': 123,
        'MaximumGameServerContainerGroupsPerInstance': 123,
        'InstanceType': 'string',
        'BillingType': 'ON_DEMAND'|'SPOT',
        'Description': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'MetricGroups': [
            'string',
        ],
        'NewGameSessionProtectionPolicy': 'NoProtection'|'FullProtection',
        'GameSessionCreationLimitPolicy': {
            'NewGameSessionsPerCreator': 123,
            'PolicyPeriodInMinutes': 123
        },
        'Status': 'PENDING'|'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVE'|'UPDATING'|'DELETING',
        'DeploymentDetails': {
            'LatestDeploymentId': 'string'
        },
        'LogConfiguration': {
            'LogDestination': 'NONE'|'CLOUDWATCH'|'S3',
            'S3BucketName': 'string',
            'LogGroupArn': 'string'
        },
        'LocationAttributes': [
            {
                'Location': 'string',
                'Status': 'PENDING'|'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVE'|'UPDATING'|'DELETING'
            },
        ]
    }
}

Response Structure

(dict) –
- ContainerFleet (dict) –
  
  The properties for the requested container fleet, including current status.
  - FleetId (string) –
    
    A unique identifier for the container fleet to retrieve.
  - FleetArn (string) –
    
    The Amazon Resource Name ( ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value.
  - FleetRoleArn (string) –
    
    The unique identifier for an Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift. See Set up an IAM service role. This fleet property can’t be changed.
  - GameServerContainerGroupDefinitionName (string) –
    
    The name of the fleet’s game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.
  - GameServerContainerGroupDefinitionArn (string) –
    
    The Amazon Resource Name ( ARN) that is assigned to the fleet’s game server container group. The ARN value also identifies the specific container group definition version in use.
  - PerInstanceContainerGroupDefinitionName (string) –
    
    The name of the fleet’s per-instance container group definition.
  - PerInstanceContainerGroupDefinitionArn (string) –
    
    The Amazon Resource Name ( ARN) that is assigned to the fleet’s per-instance container group. The ARN value also identifies the specific container group definition version in use.
  - InstanceConnectionPortRange (dict) –
    
    The set of port numbers to open on each instance in a container fleet. Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.
    - FromPort (integer) –
      
      Starting value for the port range.
    - ToPort (integer) –
      
      Ending value for the port. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.
  - InstanceInboundPermissions (list) –
    
    The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
    - (dict) –
      
      A range of IP addresses and port settings that allow inbound traffic to connect to processes on an instance in a fleet. Processes are assigned an IP address/port number combination, which must fall into the fleet’s allowed ranges. For managed container fleets, the port settings must use the same port numbers as the fleet’s connection ports.
      
      For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP.
      - FromPort (integer) –
        
        A starting value for a range of allowed port numbers.
        
        For fleets using Linux builds, only ports 22 and 1026-60000 are valid.
        
        For fleets using Windows builds, only ports 1026-60000 are valid.
      - ToPort (integer) –
        
        An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.
        
        For fleets using Linux builds, only ports 22 and 1026-60000 are valid.
        
        For fleets using Windows builds, only ports 1026-60000 are valid.
      - IpRange (string) –
        
        A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: “ 000.000.000.000/[subnet mask]” or optionally the shortened version “ 0.0.0.0/[subnet mask]”.
      - Protocol (string) –
        
        The network communication protocol used by the fleet.
  - GameServerContainerGroupsPerInstance (integer) –
    
    The number of times to replicate the game server container group on each fleet instance.
  - MaximumGameServerContainerGroupsPerInstance (integer) –
    
    The calculated maximum number of game server container group that can be deployed on each fleet instance. The calculation depends on the resource needs of the container group and the CPU and memory resources of the fleet’s instance type.
  - InstanceType (string) –
    
    The Amazon EC2 instance type to use for all instances in the fleet. Instance type determines the computing resources and processing power that’s available to host your game servers. This includes including CPU, memory, storage, and networking capacity. You can’t update this fleet property.
  - BillingType (string) –
    
    Indicates whether the fleet uses On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances. You can’t update this fleet property.
    
    By default, this property is set to ON_DEMAND.
  - Description (string) –
    
    A meaningful description of the container fleet.
  - 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").
  - MetricGroups (list) –
    
    The name of an Amazon Web Services CloudWatch metric group to add this fleet to. Metric groups aggregate metrics for multiple fleets.
    - (string) –
  - NewGameSessionProtectionPolicy (string) –
    
    Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession.
    - NoProtection – Game sessions can be shut down during active gameplay.
    - FullProtection – Game sessions in ACTIVE status can’t be shut down.
  - GameSessionCreationLimitPolicy (dict) –
    
    A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.
    - NewGameSessionsPerCreator (integer) –
      
      A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players’ ability to consume available resources.
      
      The policy evaluates when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.
    - PolicyPeriodInMinutes (integer) –
      
      The time span used in evaluating the resource creation limit policy.
  - Status (string) –
    
    The current status of the container fleet.
    - PENDING – A new container fleet has been requested.
    - CREATING – A new container fleet resource is being created.
    - CREATED – A new container fleet resource has been created. No fleet instances have been deployed.
    - ACTIVATING – New container fleet instances are being deployed.
    - ACTIVE – The container fleet has been deployed and is ready to host game sessions.
    - UPDATING – Updates to the container fleet is being updated. A deployment is in progress.
  - DeploymentDetails (dict) –
    
    Information about the most recent deployment for the container fleet.
    - LatestDeploymentId (string) –
      
      A unique identifier for a fleet deployment.
  - LogConfiguration (dict) –
    
    The method that is used to collect container logs for the fleet. Amazon GameLift saves all standard output for each container in logs, including game session logs.
    - CLOUDWATCH – Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group.
    - S3 – Store logs in an Amazon S3 bucket that you define.
    - NONE – Don’t collect container logs.
    - LogDestination (string) –
      
      The type of log collection to use for a fleet.
      - CLOUDWATCH – (default value) Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group.
      - S3 – Store logs in an Amazon S3 bucket that you define.
      - NONE – Don’t collect container logs.
    - S3BucketName (string) –
      
      If log destination is S3, logs are sent to the specified Amazon S3 bucket name.
    - LogGroupArn (string) –
      
      If log destination is CLOUDWATCH, logs are sent to the specified log group in Amazon CloudWatch.
  - LocationAttributes (list) –
    
    Information about the container fleet’s remote locations where fleet instances are deployed.
    - (dict) –
      
      Details about a location in a multi-location container fleet.
      - Location (string) –
        
        A location identifier.
      - Status (string) –
        
        The status of fleet activity in the location.
        
        PENDING – A new container fleet has been requested.
        
        CREATING – A new container fleet resource is being created.
        
        CREATED – A new container fleet resource has been created. No fleet instances have been deployed.
        
        ACTIVATING – New container fleet instances are being deployed.
        
        ACTIVE – The container fleet has been deployed and is ready to host game sessions.
        
        UPDATING – Updates to the container fleet is being updated. A deployment is in progress.

Exceptions

GameLift.Client.exceptions.InternalServiceException
GameLift.Client.exceptions.NotFoundException
GameLift.Client.exceptions.InvalidRequestException
GameLift.Client.exceptions.UnauthorizedException
GameLift.Client.exceptions.UnsupportedRegionException