Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . deadline ]

search-steps¶

Description¶

Searches for steps.

Synopsis¶

  search-steps
--farm-id <value>
--queue-ids <value>
[--job-id <value>]
[--filter-expressions <value>]
[--sort-expressions <value>]
--item-offset <value>
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options¶

--farm-id (string)

The farm ID to use for the step search.

--queue-ids (list)

The queue IDs in the step search.

(string)

Syntax:

"string" "string" ...

--job-id (string)

The job ID to use in the step search.

--filter-expressions (structure)

The search terms for a resource.

filters -> (list)

The filters to use for the search.

(tagged union structure)

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, parameterFilter, searchTermFilter, stringFilter, stringListFilter, groupFilter.

dateTimeFilter -> (structure)

Filters based on date and time.

name -> (string)

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

operator -> (string)

The type of comparison to use to filter the results.

dateTime -> (timestamp)

The date and time.

parameterFilter -> (structure)

Filters by parameter.

name -> (string)

The name of the parameter to filter on.

operator -> (string)

The type of comparison to use to filter results.

value -> (string)

The parameter’s value.

searchTermFilter -> (structure)

Filters by a specified search term.

searchTerm -> (string)

The term to search for.

matchType -> (string)

Specifies how Deadline Cloud matches your search term in the results. If you don’t specify a matchType the default is FUZZY_MATCH .

FUZZY_MATCH - Matches if a portion of the search term is found in the result.

CONTAINS - Matches if the exact search term is contained in the result.

stringFilter -> (structure)

Filters by a string.

name -> (string)

The field name to search.

operator -> (string)

The type of comparison to use for this search.

value -> (string)

The string to search for.

stringListFilter -> (structure)

Filters by a list of string values.

name -> (string)

The field name to search.

operator -> (string)

The type of comparison to use for this search. ANY_EQUALS and ALL_NOT_EQUALS are supported.

values -> (list)

The list of string values to search for.

(string)

groupFilter -> (structure)

Filters by group.

filters -> (list)

The filters to use for the search.

(tagged union structure)

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, parameterFilter, searchTermFilter, stringFilter, stringListFilter, groupFilter.

dateTimeFilter -> (structure)

Filters based on date and time.

name -> (string)

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

operator -> (string)

The type of comparison to use to filter the results.

dateTime -> (timestamp)

The date and time.

parameterFilter -> (structure)

Filters by parameter.

name -> (string)

The name of the parameter to filter on.

operator -> (string)

The type of comparison to use to filter results.

value -> (string)

The parameter’s value.

searchTermFilter -> (structure)

Filters by a specified search term.

searchTerm -> (string)

The term to search for.

matchType -> (string)

Specifies how Deadline Cloud matches your search term in the results. If you don’t specify a matchType the default is FUZZY_MATCH .

FUZZY_MATCH - Matches if a portion of the search term is found in the result.

CONTAINS - Matches if the exact search term is contained in the result.

stringFilter -> (structure)

Filters by a string.

name -> (string)

The field name to search.

operator -> (string)

The type of comparison to use for this search.

value -> (string)

The string to search for.

stringListFilter -> (structure)

Filters by a list of string values.

name -> (string)

The field name to search.

operator -> (string)

The type of comparison to use for this search. ANY_EQUALS and ALL_NOT_EQUALS are supported.

values -> (list)

The list of string values to search for.

(string)

( … recursive … )

operator -> (string)

The operators to include in the search.

operator -> (string)

The operators to include in the search.

JSON Syntax:

{
  "filters": [
    {
      "dateTimeFilter": {
        "name": "string",
        "operator": "EQUAL"|"NOT_EQUAL"|"GREATER_THAN_EQUAL_TO"|"GREATER_THAN"|"LESS_THAN_EQUAL_TO"|"LESS_THAN"|"ANY_EQUALS"|"ALL_NOT_EQUALS",
        "dateTime": timestamp
      },
      "parameterFilter": {
        "name": "string",
        "operator": "EQUAL"|"NOT_EQUAL"|"GREATER_THAN_EQUAL_TO"|"GREATER_THAN"|"LESS_THAN_EQUAL_TO"|"LESS_THAN"|"ANY_EQUALS"|"ALL_NOT_EQUALS",
        "value": "string"
      },
      "searchTermFilter": {
        "searchTerm": "string",
        "matchType": "FUZZY_MATCH"|"CONTAINS"
      },
      "stringFilter": {
        "name": "string",
        "operator": "EQUAL"|"NOT_EQUAL"|"GREATER_THAN_EQUAL_TO"|"GREATER_THAN"|"LESS_THAN_EQUAL_TO"|"LESS_THAN"|"ANY_EQUALS"|"ALL_NOT_EQUALS",
        "value": "string"
      },
      "stringListFilter": {
        "name": "string",
        "operator": "EQUAL"|"NOT_EQUAL"|"GREATER_THAN_EQUAL_TO"|"GREATER_THAN"|"LESS_THAN_EQUAL_TO"|"LESS_THAN"|"ANY_EQUALS"|"ALL_NOT_EQUALS",
        "values": ["string", ...]
      },
      "groupFilter": {
        "filters": [
          {
            "dateTimeFilter": {
              "name": "string",
              "operator": "EQUAL"|"NOT_EQUAL"|"GREATER_THAN_EQUAL_TO"|"GREATER_THAN"|"LESS_THAN_EQUAL_TO"|"LESS_THAN"|"ANY_EQUALS"|"ALL_NOT_EQUALS",
              "dateTime": timestamp
            },
            "parameterFilter": {
              "name": "string",
              "operator": "EQUAL"|"NOT_EQUAL"|"GREATER_THAN_EQUAL_TO"|"GREATER_THAN"|"LESS_THAN_EQUAL_TO"|"LESS_THAN"|"ANY_EQUALS"|"ALL_NOT_EQUALS",
              "value": "string"
            },
            "searchTermFilter": {
              "searchTerm": "string",
              "matchType": "FUZZY_MATCH"|"CONTAINS"
            },
            "stringFilter": {
              "name": "string",
              "operator": "EQUAL"|"NOT_EQUAL"|"GREATER_THAN_EQUAL_TO"|"GREATER_THAN"|"LESS_THAN_EQUAL_TO"|"LESS_THAN"|"ANY_EQUALS"|"ALL_NOT_EQUALS",
              "value": "string"
            },
            "stringListFilter": {
              "name": "string",
              "operator": "EQUAL"|"NOT_EQUAL"|"GREATER_THAN_EQUAL_TO"|"GREATER_THAN"|"LESS_THAN_EQUAL_TO"|"LESS_THAN"|"ANY_EQUALS"|"ALL_NOT_EQUALS",
              "values": ["string", ...]
            },
            "groupFilter": { ... recursive ... }
          }
          ...
        ],
        "operator": "AND"|"OR"
      }
    }
    ...
  ],
  "operator": "AND"|"OR"
}

--sort-expressions (list)

The search terms for a resource.

(tagged union structure)

The resources to search.

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

userJobsFirst -> (structure)

Options for sorting a particular user’s jobs first.

userIdentityId -> (string)

The user’s ID.

fieldSort -> (structure)

Options for sorting by a field.

sortOrder -> (string)

The sort order for the field.

name -> (string)

The name of the field.

parameterSort -> (structure)

Options for sorting by a parameter.

sortOrder -> (string)

The sort order for the parameter.

name -> (string)

The parameter name to sort by.

Shorthand Syntax:

userJobsFirst={userIdentityId=string},fieldSort={sortOrder=string,name=string},parameterSort={sortOrder=string,name=string} ...

JSON Syntax:

[
  {
    "userJobsFirst": {
      "userIdentityId": "string"
    },
    "fieldSort": {
      "sortOrder": "ASCENDING"|"DESCENDING",
      "name": "string"
    },
    "parameterSort": {
      "sortOrder": "ASCENDING"|"DESCENDING",
      "name": "string"
    }
  }
  ...
]

--item-offset (integer)

The offset for the search results.

--page-size (integer)

Specifies the number of results to return.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output¶

steps -> (list)

The steps in the search.

(structure)

The details of a step search.

stepId -> (string)

The step ID.

jobId -> (string)

The job ID.

queueId -> (string)

The queue ID.

name -> (string)

The step name.

lifecycleStatus -> (string)

The life cycle status.

lifecycleStatusMessage -> (string)

The life cycle status message.

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.

targetTaskRunStatus -> (string)

The task status to update the job’s tasks to.

taskRunStatusCounts -> (map)

The number of tasks running on the job.

key -> (string)

value -> (integer)

taskFailureRetryCount -> (integer)

The total number of times tasks from the step failed and were retried.

createdAt -> (timestamp)

The date and time the resource was created.

createdBy -> (string)

The user or system that created this resource.

startedAt -> (timestamp)

The date and time the resource started running.

endedAt -> (timestamp)

The date and time the resource ended running.

updatedAt -> (timestamp)

The date and time the resource was updated.

updatedBy -> (string)

The user or system that updated this resource.

parameterSpace -> (structure)

The parameters and combination expressions for the search.

parameters -> (list)

The parameters to search for.

(structure)

The details of a step parameter.

name -> (string)

The name of the parameter.

type -> (string)

The data type of the parameter.

chunks -> (structure)

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.

nextItemOffset -> (integer)

The next item offset for the search results.

totalResults -> (integer)

The total number of results in the search.

Table of Contents

Feedback

User Guide

Note:

search-steps¶

Description¶

Synopsis¶

Options¶

Note

Note

Note

Global Options¶

Output¶