AWS CLI Command Reference

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 ]

batch-get-session-action

Description

Retrieves multiple session actions in a single request. This is a batch version of the GetSessionAction API.

The result of getting each session action 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

Synopsis

  batch-get-session-action
--identifiers <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

--identifiers (list)

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

(structure)

The identifiers for a session action.

farmId -> (string)

The farm ID of the session action.

queueId -> (string)

The queue ID of the session action.

jobId -> (string)

The job ID of the session action.

sessionActionId -> (string)

The session action ID.

Shorthand Syntax:

farmId=string,queueId=string,jobId=string,sessionActionId=string ...

JSON Syntax:

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

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

sessionActions -> (list)

A list of session actions that were successfully retrieved.

(structure)

The details of a session action returned in a batch get operation.

farmId -> (string)

The farm ID of the session action.

queueId -> (string)

The queue ID of the session action.

jobId -> (string)

The job ID of the session action.

sessionActionId -> (string)

The session action ID.

status -> (string)

The status of the session action.

startedAt -> (timestamp)

The date and time the resource started running.

endedAt -> (timestamp)

The date and time the resource ended running.

workerUpdatedAt -> (timestamp)

The date and time the resource was updated by a worker.

progressPercent -> (float)

The completion percentage for the session action.

manifests -> (list)

The manifests for the session action.

(structure)

The manifest properties for a task run, corresponding to the manifest properties in the job.

outputManifestPath -> (string)

The manifest file path.

outputManifestHash -> (string)

The hash value of the file.

sessionId -> (string)

The session ID for the session action.

processExitCode -> (integer)

The exit code to apply to the session action.

progressMessage -> (string)

The message that communicates the progress of the session action.

acquiredLimits -> (list)

The limits that were acquired for the session action.

(structure)

Provides information about the number of resources used.

limitId -> (string)

The unique identifier of the limit.

count -> (integer)

The number of limit resources used.

definition -> (tagged union structure)

The session action definition.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: envEnter, envExit, taskRun, syncInputJobAttachments.

envEnter -> (structure)

The environment to enter into.

environmentId -> (string)

The environment ID.

envExit -> (structure)

The environment to exit from.

environmentId -> (string)

The environment ID.

taskRun -> (structure)

The task run in the session.

taskId -> (string)

The task ID.

stepId -> (string)

The step ID.

parameters -> (map)

The task parameters.

key -> (string)

value -> (tagged union structure)

The data types for the task parameters.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: int, float, string, path, chunkInt.

int -> (string)

A signed integer represented as a string.

float -> (string)

A double precision IEEE-754 floating point number represented as a string.

string -> (string)

A UTF-8 string.

path -> (string)

A file system path represented as a string.

chunkInt -> (string)

A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string.

syncInputJobAttachments -> (structure)

The session action definition for syncing input job attachments.

stepId -> (string)

The step ID for the sync input job attachments session action.

errors -> (list)

A list of errors for session actions that could not be retrieved.

(structure)

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

farmId -> (string)

The farm ID of the session action that could not be retrieved.

queueId -> (string)

The queue ID of the session action that could not be retrieved.

jobId -> (string)

The job ID of the session action that could not be retrieved.

sessionActionId -> (string)

The session action ID of the session action that could not be retrieved.

code -> (string)

The error code.

message -> (string)

The error message.