DeadlineCloud / Paginator / ListFleets

ListFleets#

class DeadlineCloud.Paginator.ListFleets#
paginator = client.get_paginator('list_fleets')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from DeadlineCloud.Client.list_fleets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    farmId='string',
    principalId='string',
    displayName='string',
    status='ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • farmId (string) –

    [REQUIRED]

    The farm ID of the fleets.

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

  • displayName (string) –

    The display names of a list of fleets.

    Warning

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • fleets (list) –

      The fleets on the list.

      • (dict) –

        The details of a fleet.

        • fleetId (string) –

          The fleet ID.

        • farmId (string) –

          The farm ID.

        • displayName (string) –

          The display name of the fleet summary to update.

          Warning

          This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

        • status (string) –

          The status of the fleet.

        • autoScalingStatus (string) –

          The Auto Scaling status of a fleet.

        • targetWorkerCount (integer) –

          The target number of workers in a fleet.

        • workerCount (integer) –

          The number of workers in the fleet summary.

        • minWorkerCount (integer) –

          The minimum number of workers in the fleet.

        • maxWorkerCount (integer) –

          The maximum number of workers specified in the 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.

            • workerCapabilities (dict) –

              The worker capabilities for a customer managed fleet configuration.

              • vCpuCount (dict) –

                The vCPU count for the customer manged worker capabilities.

                • min (integer) –

                  The minimum amount of vCPU.

                • max (integer) –

                  The maximum amount of vCPU.

              • memoryMiB (dict) –

                The memory (MiB).

                • min (integer) –

                  The minimum amount of memory (in MiB).

                • max (integer) –

                  The maximum amount of memory (in MiB).

              • acceleratorTypes (list) –

                The accelerator types for the customer managed worker capabilities.

                • (string) –

              • acceleratorCount (dict) –

                The range of the accelerator.

                • min (integer) –

                  The minimum GPU for the accelerator.

                • max (integer) –

                  The maximum GPU for the accelerator.

              • acceleratorTotalMemoryMiB (dict) –

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

                • min (integer) –

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

                • max (integer) –

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

              • osFamily (string) –

                The operating system (OS) family.

              • 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.

                  • name (string) –

                    The name of the fleet capability.

                  • min (float) –

                    The minimum amount of fleet worker capability.

                  • max (float) –

                    The maximum amount of the fleet worker 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) –

            • storageProfileId (string) –

              The storage profile ID.

          • serviceManagedEc2 (dict) –

            The service managed Amazon EC2 instances for a fleet configuration.

            • instanceCapabilities (dict) –

              The Amazon EC2 instance capabilities.

              • vCpuCount (dict) –

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

                • min (integer) –

                  The minimum amount of vCPU.

                • max (integer) –

                  The maximum amount of vCPU.

              • memoryMiB (dict) –

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

                • min (integer) –

                  The minimum amount of memory (in MiB).

                • max (integer) –

                  The maximum amount of memory (in MiB).

              • osFamily (string) –

                The operating system (OS) family.

              • cpuArchitectureType (string) –

                The CPU architecture type.

              • rootEbsVolume (dict) –

                The root EBS volume.

                • sizeGiB (integer) –

                  The EBS volume size in GiB.

                • iops (integer) –

                  The IOPS per volume.

                • throughputMiB (integer) –

                  The throughput per volume in MiB.

              • allowedInstanceTypes (list) –

                The allowable Amazon EC2 instance types.

                • (string) –

              • excludedInstanceTypes (list) –

                The instance types to exclude from the fleet.

                • (string) –

              • customAmounts (list) –

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

                • (dict) –

                  The fleet amount and attribute capabilities.

                  • name (string) –

                    The name of the fleet capability.

                  • min (float) –

                    The minimum amount of fleet worker capability.

                  • max (float) –

                    The maximum amount of the fleet worker 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) –

            • 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.

        • updatedAt (datetime) –

          The date and time the resource was updated.

        • updatedBy (string) –

          The user or system that updated this resource.

    • NextToken (string) –

      A token to resume pagination.