DeadlineCloud / Client / search_steps

search_steps#

DeadlineCloud.Client.search_steps(**kwargs)#

Searches for steps.

See also: AWS API Documentation

Request Syntax

response = client.search_steps(
    farmId='string',
    filterExpressions={
        'filters': [
            {
                'dateTimeFilter': {
                    'dateTime': datetime(2015, 1, 1),
                    'name': 'string',
                    'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN'
                },
                'groupFilter': {'... recursive ...'},
                'parameterFilter': {
                    'name': 'string',
                    'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
                    'value': 'string'
                },
                'searchTermFilter': {
                    'searchTerm': 'string'
                },
                'stringFilter': {
                    'name': 'string',
                    'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
                    'value': 'string'
                }
            },
        ],
        'operator': 'AND'|'OR'
    },
    itemOffset=123,
    jobId='string',
    pageSize=123,
    queueIds=[
        'string',
    ],
    sortExpressions=[
        {
            'fieldSort': {
                'name': 'string',
                'sortOrder': 'ASCENDING'|'DESCENDING'
            },
            'parameterSort': {
                'name': 'string',
                'sortOrder': 'ASCENDING'|'DESCENDING'
            },
            'userJobsFirst': {
                'userIdentityId': 'string'
            }
        },
    ]
)
Parameters:

  • farmId (string) –

    [REQUIRED]

    The farm ID to use for the step search.

  • filterExpressions (dict) –

    The filter expression, AND or OR, to use when searching among a group of search strings in a resource.

    You can use two groupings per search each within parenthesis ().

    • filters (list) – [REQUIRED]

      The filters to use for the search.

      • (dict) –

        The type of search filter to apply.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: dateTimeFilter, groupFilter, parameterFilter, searchTermFilter, stringFilter.

        • dateTimeFilter (dict) –

          Filters based on date and time.

          • dateTime (datetime) – [REQUIRED]

            The date and time.

          • name (string) – [REQUIRED]

            The name of the date-time field to filter on.

          • operator (string) – [REQUIRED]

            The type of comparison to use to filter the results.

        • groupFilter (dict) –

          Filters by group.

        • parameterFilter (dict) –

          Filters by parameter.

          • name (string) – [REQUIRED]

            The name of the parameter to filter on.

          • operator (string) – [REQUIRED]

            The type of comparison to use to filter results.

          • value (string) – [REQUIRED]

            The parameter’s value.

        • searchTermFilter (dict) –

          Filters by a specified search term.

          • searchTerm (string) – [REQUIRED]

            The term to search for.

        • stringFilter (dict) –

          Filters by a string.

          • name (string) – [REQUIRED]

            The field name to search.

          • operator (string) – [REQUIRED]

            The type of comparison to use for this search.

          • value (string) – [REQUIRED]

            The string to search for.

    • operator (string) – [REQUIRED]

      The operators to include in the search.

  • itemOffset (integer) –

    [REQUIRED]

    Defines how far into the scrollable list to start the return of results.

  • jobId (string) – The job ID to use in the step search.

  • pageSize (integer) – Specifies the number of items per page for the resource.

  • queueIds (list) –

    [REQUIRED]

    The queue IDs in the step search.

    • (string) –

  • sortExpressions (list) –

    The search terms for a resource.

    • (dict) –

      The resources to search.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: fieldSort, parameterSort, userJobsFirst.

      • fieldSort (dict) –

        Options for sorting by a field.

        • name (string) – [REQUIRED]

          The name of the field.

        • sortOrder (string) – [REQUIRED]

          The sort order for the field.

      • parameterSort (dict) –

        Options for sorting by a parameter.

        • name (string) – [REQUIRED]

          The parameter name to sort by.

        • sortOrder (string) – [REQUIRED]

          The sort order for the parameter.

      • userJobsFirst (dict) –

        Options for sorting a particular user’s jobs first.

        • userIdentityId (string) – [REQUIRED]

          The user’s ID.

Return type:

dict

Returns:

Response Syntax

{
    'nextItemOffset': 123,
    'steps': [
        {
            'createdAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'jobId': 'string',
            'lifecycleStatus': 'CREATE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED',
            'lifecycleStatusMessage': 'string',
            'name': 'string',
            'parameterSpace': {
                'combination': 'string',
                'parameters': [
                    {
                        'name': 'string',
                        'type': 'INT'|'FLOAT'|'STRING'|'PATH'
                    },
                ]
            },
            'queueId': 'string',
            'startedAt': datetime(2015, 1, 1),
            'stepId': 'string',
            'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
            'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
            'taskRunStatusCounts': {
                'string': 123
            }
        },
    ],
    'totalResults': 123
}

Response Structure

  • (dict) –

    • nextItemOffset (integer) –

      The next incremental starting point after the defined itemOffset.

    • steps (list) –

      The steps in the search.

      • (dict) –

        The details of a step search.

        • createdAt (datetime) –

          The date and time the resource was created.

        • endedAt (datetime) –

          The date and time the resource ended running.

        • jobId (string) –

          The job ID.

        • lifecycleStatus (string) –

          The life cycle status.

        • lifecycleStatusMessage (string) –

          The life cycle status message.

        • name (string) –

          The step name.

        • parameterSpace (dict) –

          The parameters and combination expressions for the search.

          • combination (string) –

            The combination expression to use in the search.

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

        • queueId (string) –

          The queue ID.

        • startedAt (datetime) –

          The date and time the resource started running.

        • stepId (string) –

          The step ID.

        • targetTaskRunStatus (string) –

          The task status to start with on the job.

        • taskRunStatus (string) –

          The task run status for the job.

          • PENDING–pending and waiting for resources.

          • READY–ready to be processed.

          • ASSIGNED–assigned and will run next on a worker.

          • SCHEDULED–scheduled to be run on a worker.

          • INTERRUPTING–being interrupted.

          • RUNNING–running on a worker.

          • SUSPENDED–the task is suspended.

          • CANCELED–the task has been canceled.

          • FAILED–the task has failed.

          • SUCCEEDED–the task has succeeded.

        • taskRunStatusCounts (dict) –

          The number of tasks running on the job.

          • (string) –

            • (integer) –

    • totalResults (integer) –

      The total number of results in the search.

Exceptions

  • DeadlineCloud.Client.exceptions.AccessDeniedException

  • DeadlineCloud.Client.exceptions.InternalServerErrorException

  • DeadlineCloud.Client.exceptions.ResourceNotFoundException

  • DeadlineCloud.Client.exceptions.ThrottlingException

  • DeadlineCloud.Client.exceptions.ValidationException