batch-get-step¶

Description¶

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.

Synopsis¶

  batch-get-step
--identifiers <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--identifiers (list) [required]

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

Constraints:

min: 1

max: 100

(structure)

The identifiers for a step.

farmId -> (string) [required]

The farm ID of the step.

Constraints:

pattern: farm-[0-9a-f]{32}

queueId -> (string) [required]

The queue ID of the step.

Constraints:

pattern: queue-[0-9a-f]{32}

jobId -> (string) [required]

The job ID of the step.

Constraints:

pattern: job-[0-9a-f]{32}

stepId -> (string) [required]

The step ID.

Constraints:

pattern: step-[0-9a-f]{32}

Shorthand Syntax:

farmId=string,queueId=string,jobId=string,stepId=string ...

JSON Syntax:

[
  {
    "farmId": "string",
    "queueId": "string",
    "jobId": "string",
    "stepId": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

steps -> (list)

A list of steps that were successfully retrieved.

(structure)

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

farmId -> (string) [required]

The farm ID of the step.

Constraints:

pattern: farm-[0-9a-f]{32}

queueId -> (string) [required]

The queue ID of the step.

Constraints:

pattern: queue-[0-9a-f]{32}

jobId -> (string) [required]

The job ID of the step.

Constraints:

pattern: job-[0-9a-f]{32}

stepId -> (string) [required]

The step ID.

Constraints:

pattern: step-[0-9a-f]{32}

name -> (string) [required]

The name of the step.

Constraints:

min: 1

max: 64

lifecycleStatus -> (string) [required]

The life cycle status of the step.

Possible values:

CREATE_COMPLETE

UPDATE_IN_PROGRESS

UPDATE_FAILED

UPDATE_SUCCEEDED

lifecycleStatusMessage -> (string)

A message that communicates the status of the life cycle.

taskRunStatus -> (string) [required]

The task run status for the step.

Possible values:

PENDING

READY

ASSIGNED

STARTING

SCHEDULED

INTERRUPTING

RUNNING

SUSPENDED

CANCELED

FAILED

SUCCEEDED

NOT_COMPATIBLE

taskRunStatusCounts -> (map) [required]

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

key -> (string)

Possible values:

PENDING

READY

ASSIGNED

STARTING

SCHEDULED

INTERRUPTING

RUNNING

SUSPENDED

CANCELED

FAILED

SUCCEEDED

NOT_COMPATIBLE

value -> (integer)

taskFailureRetryCount -> (integer)

The number of times that tasks failed and were retried.

Constraints:

min: 0

max: 2147483647

targetTaskRunStatus -> (string)

The task status to start with on the step.

Possible values:

READY

FAILED

SUCCEEDED

CANCELED

SUSPENDED

PENDING

createdAt -> (timestamp) [required]

The date and time the resource was created.

createdBy -> (string) [required]

The user or system that created this resource.

updatedAt -> (timestamp)

The date and time the resource was updated.

updatedBy -> (string)

The user or system that updated this resource.

startedAt -> (timestamp)

The date and time the resource started running.

endedAt -> (timestamp)

The date and time the resource ended running.

dependencyCounts -> (structure)

The number of dependencies for the step.

dependenciesResolved -> (integer) [required]

The number of resolved dependencies.

dependenciesUnresolved -> (integer) [required]

The number of unresolved dependencies.

consumersResolved -> (integer) [required]

The number of consumers resolved.

consumersUnresolved -> (integer) [required]

The number of unresolved consumers.

requiredCapabilities -> (structure)

The required capabilities for the step.

attributes -> (list) [required]

The capability attributes that the step requires.

Constraints:

min: 0

max: 25

(structure)

The list of step attributes.

name -> (string) [required]

The name of the step attribute.

Constraints:

min: 1

max: 100

pattern: ([a-zA-Z][a-zA-Z0-9]{0,63}:)?attr(\.[a-zA-Z][a-zA-Z0-9]{0,63})+

anyOf -> (list)

Requires any of the step attributes in a given list.

(string)

Constraints:

min: 1

max: 100

pattern: [a-zA-Z_]([a-zA-Z0-9_\-]{0,99})

allOf -> (list)

Requires all of the step attribute values.

(string)

Constraints:

min: 1

max: 100

pattern: [a-zA-Z_]([a-zA-Z0-9_\-]{0,99})

amounts -> (list) [required]

The capability amounts that the step requires.

Constraints:

min: 0

max: 25

(structure)

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

name -> (string) [required]

The name of the step.

Constraints:

min: 1

max: 100

pattern: ([a-zA-Z][a-zA-Z0-9]{0,63}:)?amount(\.[a-zA-Z][a-zA-Z0-9]{0,63})+

min -> (double)

The minimum amount.

max -> (double)

The maximum amount.

value -> (double)

The amount value.

parameterSpace -> (structure)

The parameter space for the step.

parameters -> (list) [required]

The parameters to search for.

(structure)

The details of a step parameter.

name -> (string) [required]

The name of the parameter.

Constraints:

min: 1

max: 64

type -> (string) [required]

The data type of the parameter.

Possible values:

INT

FLOAT

STRING

PATH

CHUNK_INT

chunks -> (structure)

The configuration for task chunking.

defaultTaskCount -> (integer) [required]

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

Constraints:

min: 1

max: 2147483647

targetRuntimeSeconds -> (integer)

The number of seconds to aim for when forming chunks.

Constraints:

min: 0

max: 2147483647

rangeConstraint -> (string) [required]

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

Possible values:

CONTIGUOUS

NONCONTIGUOUS

combination -> (string)

The combination expression to use in the search.

Constraints:

min: 1

max: 1280

description -> (string)

The description of the step.

Constraints:

min: 1

max: 2048

errors -> (list)

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

(structure)

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

farmId -> (string) [required]

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

Constraints:

pattern: farm-[0-9a-f]{32}

queueId -> (string) [required]

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

Constraints:

pattern: queue-[0-9a-f]{32}

jobId -> (string) [required]

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

Constraints:

pattern: job-[0-9a-f]{32}

stepId -> (string) [required]

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

Constraints:

pattern: step-[0-9a-f]{32}

code -> (string) [required]

The error code.

Possible values:

InternalServerErrorException

ResourceNotFoundException

ValidationException

AccessDeniedException

ThrottlingException

message -> (string) [required]

The error message.

Table of Contents

Feedback

User Guide