DeadlineCloud / Client / list_fleets

list_fleets#

DeadlineCloud.Client.list_fleets(**kwargs)#

Lists fleets.

See also: AWS API Documentation

Request Syntax

response = client.list_fleets(
    displayName='string',
    farmId='string',
    maxResults=123,
    nextToken='string',
    principalId='string',
    status='ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'
)
Parameters:

  • displayName (string) – The display names of a list of fleets.

  • farmId (string) –

    [REQUIRED]

    The farm ID of the fleets.

  • maxResults (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

  • nextToken (string) – The token for the next set of results, or null to start from the beginning.

  • principalId (string) – The principal ID of the members to include in the fleet.

  • status (string) – The status of the fleet.

Return type:

dict

Returns:

Response Syntax

{
    'fleets': [
        {
            'autoScalingStatus': 'GROWING'|'STEADY'|'SHRINKING',
            'configuration': {
                'customerManaged': {
                    'mode': 'NO_SCALING'|'EVENT_BASED_AUTO_SCALING',
                    'storageProfileId': 'string',
                    'workerCapabilities': {
                        'acceleratorCount': {
                            'max': 123,
                            'min': 123
                        },
                        'acceleratorTotalMemoryMiB': {
                            'max': 123,
                            'min': 123
                        },
                        'acceleratorTypes': [
                            'gpu',
                        ],
                        'cpuArchitectureType': 'x86_64'|'arm64',
                        'customAmounts': [
                            {
                                'max': ...,
                                'min': ...,
                                'name': 'string'
                            },
                        ],
                        'customAttributes': [
                            {
                                'name': 'string',
                                'values': [
                                    'string',
                                ]
                            },
                        ],
                        'memoryMiB': {
                            'max': 123,
                            'min': 123
                        },
                        'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
                        'vCpuCount': {
                            'max': 123,
                            'min': 123
                        }
                    }
                },
                'serviceManagedEc2': {
                    'instanceCapabilities': {
                        'allowedInstanceTypes': [
                            'string',
                        ],
                        'cpuArchitectureType': 'x86_64'|'arm64',
                        'customAmounts': [
                            {
                                'max': ...,
                                'min': ...,
                                'name': 'string'
                            },
                        ],
                        'customAttributes': [
                            {
                                'name': 'string',
                                'values': [
                                    'string',
                                ]
                            },
                        ],
                        'excludedInstanceTypes': [
                            'string',
                        ],
                        'memoryMiB': {
                            'max': 123,
                            'min': 123
                        },
                        'osFamily': 'WINDOWS'|'LINUX',
                        'rootEbsVolume': {
                            'iops': 123,
                            'sizeGiB': 123,
                            'throughputMiB': 123
                        },
                        'vCpuCount': {
                            'max': 123,
                            'min': 123
                        }
                    },
                    'instanceMarketOptions': {
                        'type': 'on-demand'|'spot'
                    }
                }
            },
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'displayName': 'string',
            'farmId': 'string',
            'fleetId': 'string',
            'maxWorkerCount': 123,
            'minWorkerCount': 123,
            'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED',
            'targetWorkerCount': 123,
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'workerCount': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • fleets (list) –

      The fleets on the list.

      • (dict) –

        The details of a fleet.

        • autoScalingStatus (string) –

          The Auto Scaling status of a fleet.

        • configuration (dict) –

          The configuration details for the fleet.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: customerManaged, serviceManagedEc2. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • customerManaged (dict) –

            The customer managed fleets within a fleet configuration.

            • mode (string) –

              The Auto Scaling mode for the customer managed fleet configuration.

            • storageProfileId (string) –

              The storage profile ID.

            • workerCapabilities (dict) –

              The worker capabilities for a customer managed fleet configuration.

              • acceleratorCount (dict) –

                The range of the accelerator.

                • max (integer) –

                  The maximum GPU for the accelerator.

                • min (integer) –

                  The minimum GPU for the accelerator.

              • acceleratorTotalMemoryMiB (dict) –

                The total memory (MiB) for the customer managed worker capabilities.

                • max (integer) –

                  The maximum amount of memory to use for the accelerator, measured in MiB.

                • min (integer) –

                  The minimum amount of memory to use for the accelerator, measured in MiB.

              • acceleratorTypes (list) –

                The accelerator types for the customer managed worker capabilities.

                • (string) –

              • cpuArchitectureType (string) –

                The CPU architecture type for the customer managed worker capabilities.

              • customAmounts (list) –

                Custom requirement ranges for customer managed worker capabilities.

                • (dict) –

                  The fleet amount and attribute capabilities.

                  • max (float) –

                    The maximum amount of the fleet worker capability.

                  • min (float) –

                    The minimum amount of fleet worker capability.

                  • name (string) –

                    The name of the fleet capability.

              • customAttributes (list) –

                Custom attributes for the customer manged worker capabilities.

                • (dict) –

                  Defines the fleet’s capability name, minimum, and maximum.

                  • name (string) –

                    The name of the fleet attribute capability for the worker.

                  • values (list) –

                    The number of fleet attribute capabilities.

                    • (string) –

              • memoryMiB (dict) –

                The memory (MiB).

                • max (integer) –

                  The maximum amount of memory (in MiB).

                • min (integer) –

                  The minimum amount of memory (in MiB).

              • osFamily (string) –

                The operating system (OS) family.

              • vCpuCount (dict) –

                The vCPU count for the customer manged worker capabilities.

                • max (integer) –

                  The maximum amount of vCPU.

                • min (integer) –

                  The minimum amount of vCPU.

          • serviceManagedEc2 (dict) –

            The service managed Amazon EC2 instances for a fleet configuration.

            • instanceCapabilities (dict) –

              The Amazon EC2 instance capabilities.

              • allowedInstanceTypes (list) –

                The allowable Amazon EC2 instance types.

                • (string) –

              • cpuArchitectureType (string) –

                The CPU architecture type.

              • customAmounts (list) –

                The custom capability amounts to require for instances in this fleet.

                • (dict) –

                  The fleet amount and attribute capabilities.

                  • max (float) –

                    The maximum amount of the fleet worker capability.

                  • min (float) –

                    The minimum amount of fleet worker capability.

                  • name (string) –

                    The name of the fleet capability.

              • customAttributes (list) –

                The custom capability attributes to require for instances in this fleet.

                • (dict) –

                  Defines the fleet’s capability name, minimum, and maximum.

                  • name (string) –

                    The name of the fleet attribute capability for the worker.

                  • values (list) –

                    The number of fleet attribute capabilities.

                    • (string) –

              • excludedInstanceTypes (list) –

                The instance types to exclude from the fleet.

                • (string) –

              • memoryMiB (dict) –

                The memory, as MiB, for the Amazon EC2 instance type.

                • max (integer) –

                  The maximum amount of memory (in MiB).

                • min (integer) –

                  The minimum amount of memory (in MiB).

              • osFamily (string) –

                The operating system (OS) family.

              • rootEbsVolume (dict) –

                The root EBS volume.

                • iops (integer) –

                  The IOPS per volume.

                • sizeGiB (integer) –

                  The EBS volume size in GiB.

                • throughputMiB (integer) –

                  The throughput per volume in MiB.

              • vCpuCount (dict) –

                The amount of vCPU to require for instances in this fleet.

                • max (integer) –

                  The maximum amount of vCPU.

                • min (integer) –

                  The minimum amount of vCPU.

            • instanceMarketOptions (dict) –

              The Amazon EC2 market type.

              • type (string) –

                The Amazon EC2 instance type.

        • createdAt (datetime) –

          The date and time the resource was created.

        • createdBy (string) –

          The user or system that created this resource.

        • displayName (string) –

          The display name of the fleet summary to update.

        • farmId (string) –

          The farm ID.

        • fleetId (string) –

          The fleet ID.

        • maxWorkerCount (integer) –

          The maximum number of workers specified in the fleet.

        • minWorkerCount (integer) –

          The minimum number of workers in the fleet.

        • status (string) –

          The status of the fleet.

        • targetWorkerCount (integer) –

          The target number of workers in a fleet.

        • updatedAt (datetime) –

          The date and time the resource was updated.

        • updatedBy (string) –

          The user or system that updated this resource.

        • workerCount (integer) –

          The number of workers in the fleet summary.

    • nextToken (string) –

      If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

Exceptions