AWS CLI Command Reference

[ aws . deadline ]

batch-get-session

Description

Retrieves multiple sessions in a single request. This is a batch version of the GetSession API.

The result of getting each session 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
--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 session identifiers to retrieve. You can specify up to 100 identifiers per request.

Constraints:

  • min: 1
  • max: 100

(structure)

The identifiers for a session.

farmId -> (string) [required]

The farm ID of the session.

Constraints:

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

queueId -> (string) [required]

The queue ID of the session.

Constraints:

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

jobId -> (string) [required]

The job ID of the session.

Constraints:

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

sessionId -> (string) [required]

The session ID.

Constraints:

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

Shorthand Syntax:

farmId=string,queueId=string,jobId=string,sessionId=string ...

JSON Syntax:

[
  {
    "farmId": "string",
    "queueId": "string",
    "jobId": "string",
    "sessionId": "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

sessions -> (list)

A list of sessions that were successfully retrieved.

(structure)

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

farmId -> (string) [required]

The farm ID of the session.

Constraints:

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

queueId -> (string) [required]

The queue ID of the session.

Constraints:

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

jobId -> (string) [required]

The job ID of the session.

Constraints:

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

sessionId -> (string) [required]

The session ID.

Constraints:

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

fleetId -> (string) [required]

The fleet ID of the session.

Constraints:

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

workerId -> (string) [required]

The worker ID of the session.

Constraints:

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

startedAt -> (timestamp) [required]

The date and time the resource started running.

lifecycleStatus -> (string) [required]

The life cycle status of the session.

Possible values:

  • STARTED
  • UPDATE_IN_PROGRESS
  • UPDATE_SUCCEEDED
  • UPDATE_FAILED
  • ENDED

endedAt -> (timestamp)

The date and time the resource ended running.

targetLifecycleStatus -> (string)

The target life cycle status for the session.

Possible values:

  • ENDED

updatedAt -> (timestamp)

The date and time the resource was updated.

updatedBy -> (string)

The user or system that updated this resource.

log -> (structure) [required]

The session log.

logDriver -> (string) [required]

The log drivers for worker related logs.

Constraints:

  • min: 1
  • max: 512

options -> (map)

The options for a log driver.

key -> (string)

value -> (string)

parameters -> (map)

The parameters for the log configuration.

key -> (string)

value -> (string)

error -> (string)

The log configuration error details.

Constraints:

  • min: 1
  • max: 512

hostProperties -> (structure)

The host properties for the session.

ipAddresses -> (structure)

The IP address of the host.

ipV4Addresses -> (list)

The IpV4 address of the network.

(string)

Constraints:

  • pattern: (?:[0-9]{1,3}\.){3}[0-9]{1,3}

ipV6Addresses -> (list)

The IpV6 address for the network and node component.

(string)

Constraints:

  • pattern: (?:[A-F0-9]{1,4}:){7}[A-F0-9]{1,4}

hostName -> (string)

The host name.

Constraints:

  • pattern: [a-zA-Z0-9_\.\-]{0,255}

ec2InstanceArn -> (string)

The ARN of the host EC2 instance.

ec2InstanceType -> (string)

The instance type of the host EC2 instance.

Constraints:

  • min: 1
  • max: 100

workerLog -> (structure)

The worker log for the session.

logDriver -> (string) [required]

The log drivers for worker related logs.

Constraints:

  • min: 1
  • max: 512

options -> (map)

The options for a log driver.

key -> (string)

value -> (string)

parameters -> (map)

The parameters for the log configuration.

key -> (string)

value -> (string)

error -> (string)

The log configuration error details.

Constraints:

  • min: 1
  • max: 512

errors -> (list)

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

(structure)

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

farmId -> (string) [required]

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

Constraints:

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

queueId -> (string) [required]

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

Constraints:

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

jobId -> (string) [required]

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

Constraints:

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

sessionId -> (string) [required]

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

Constraints:

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

code -> (string) [required]

The error code.

Possible values:

  • InternalServerErrorException
  • ResourceNotFoundException
  • ValidationException

message -> (string) [required]

The error message.
© Copyright 2026, Amazon Web Services. Created using Sphinx.