DeadlineCloud / Client / batch_get_step

batch_get_step

DeadlineCloud.Client.batch_get_step(**kwargs)

Retrieves multiple steps in a single request. This is a batch version of the GetStep API.

The result of getting each step is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_step(
    identifiers=[
        {
            'farmId': 'string',
            'queueId': 'string',
            'jobId': 'string',
            'stepId': 'string'
        },
    ]
)

Parameters:

identifiers (list) –

[REQUIRED]

The list of step identifiers to retrieve. You can specify up to 100 identifiers per request.

• (dict) –

  The identifiers for a step.

  • farmId (string) – [REQUIRED]

    The farm ID of the step.

  • queueId (string) – [REQUIRED]

    The queue ID of the step.

  • jobId (string) – [REQUIRED]

    The job ID of the step.

  • stepId (string) – [REQUIRED]

    The step ID.

Return type:

dict

Returns:

Response Syntax

{
    'steps': [
        {
            'farmId': 'string',
            'queueId': 'string',
            'jobId': 'string',
            'stepId': 'string',
            'name': 'string',
            'lifecycleStatus': 'CREATE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED',
            'lifecycleStatusMessage': 'string',
            'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
            'taskRunStatusCounts': {
                'string': 123
            },
            'taskFailureRetryCount': 123,
            'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'dependencyCounts': {
                'dependenciesResolved': 123,
                'dependenciesUnresolved': 123,
                'consumersResolved': 123,
                'consumersUnresolved': 123
            },
            'requiredCapabilities': {
                'attributes': [
                    {
                        'name': 'string',
                        'anyOf': [
                            'string',
                        ],
                        'allOf': [
                            'string',
                        ]
                    },
                ],
                'amounts': [
                    {
                        'name': 'string',
                        'min': 123.0,
                        'max': 123.0,
                        'value': 123.0
                    },
                ]
            },
            'parameterSpace': {
                'parameters': [
                    {
                        'name': 'string',
                        'type': 'INT'|'FLOAT'|'STRING'|'PATH'|'CHUNK_INT',
                        'chunks': {
                            'defaultTaskCount': 123,
                            'targetRuntimeSeconds': 123,
                            'rangeConstraint': 'CONTIGUOUS'|'NONCONTIGUOUS'
                        }
                    },
                ],
                'combination': 'string'
            },
            'description': 'string'
        },
    ],
    'errors': [
        {
            'farmId': 'string',
            'queueId': 'string',
            'jobId': 'string',
            'stepId': 'string',
            'code': 'InternalServerErrorException'|'ResourceNotFoundException'|'ValidationException'|'AccessDeniedException'|'ThrottlingException',
            'message': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • steps (list) –

    A list of steps that were successfully retrieved.

    • (dict) –

      The details of a step returned in a batch get operation.

      • farmId (string) –

        The farm ID of the step.

      • queueId (string) –

        The queue ID of the step.

      • jobId (string) –

        The job ID of the step.

      • stepId (string) –

        The step ID.

      • name (string) –

        The name of the step.

      • lifecycleStatus (string) –

        The life cycle status of the step.

      • lifecycleStatusMessage (string) –

        A message that communicates the status of the life cycle.

      • taskRunStatus (string) –

        The task run status for the step.

      • taskRunStatusCounts (dict) –

        The number of tasks for each run status for the step.

        • (string) –

          • (integer) –

      • taskFailureRetryCount (integer) –

        The number of times that tasks failed and were retried.

      • targetTaskRunStatus (string) –

        The task status to start with on the step.

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

      • startedAt (datetime) –

        The date and time the resource started running.

      • endedAt (datetime) –

        The date and time the resource ended running.

      • dependencyCounts (dict) –

        The number of dependencies for the step.

        • dependenciesResolved (integer) –

          The number of resolved dependencies.

        • dependenciesUnresolved (integer) –

          The number of unresolved dependencies.

        • consumersResolved (integer) –

          The number of consumers resolved.

        • consumersUnresolved (integer) –

          The number of unresolved consumers.

      • requiredCapabilities (dict) –

        The required capabilities for the step.

        • attributes (list) –

          The capability attributes that the step requires.

          • (dict) –

            The list of step attributes.

            • name (string) –

              The name of the step attribute.

            • anyOf (list) –

              Requires any of the step attributes in a given list.

              • (string) –

            • allOf (list) –

              Requires all of the step attribute values.

              • (string) –

        • amounts (list) –

          The capability amounts that the step requires.

          • (dict) –

            The details outlining the minimum and maximum capability of a step.

            • name (string) –

              The name of the step.

            • min (float) –

              The minimum amount.

            • max (float) –

              The maximum amount.

            • value (float) –

              The amount value.

      • parameterSpace (dict) –

        The parameter space for the step.

        • parameters (list) –

          The parameters to search for.

          • (dict) –

            The details of a step parameter.

            • name (string) –

              The name of the parameter.

            • type (string) –

              The data type of the parameter.

            • chunks (dict) –

              The configuration for task chunking.

              • defaultTaskCount (integer) –

                The number of tasks to combine into a single chunk by default.

              • targetRuntimeSeconds (integer) –

                The number of seconds to aim for when forming chunks.

              • rangeConstraint (string) –

                Specifies whether the chunked ranges must be contiguous or can have gaps between them.

        • combination (string) –

          The combination expression to use in the search.

      • description (string) –

        The description of the step.

  • errors (list) –

    A list of errors for steps that could not be retrieved.

    • (dict) –

      The error details for a step that could not be retrieved in a batch get operation.

      • farmId (string) –

        The farm ID of the step that could not be retrieved.

      • queueId (string) –

        The queue ID of the step that could not be retrieved.

      • jobId (string) –

        The job ID of the step that could not be retrieved.

      • stepId (string) –

        The step ID of the step that could not be retrieved.

      • code (string) –

        The error code.

      • message (string) –

        The error message.

Exceptions

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ValidationException