Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . deadline ]

get-session-action

Description

Gets a session action for the job.

See also: AWS API Documentation

Synopsis

  get-session-action
--farm-id <value>
--queue-id <value>
--job-id <value>
--session-action-id <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>]

Options

--farm-id (string)

The farm ID for the session action.

--queue-id (string)

The queue ID for the session action.

--job-id (string)

The job ID for the session.

--session-action-id (string)

The session action ID for the session.

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

Output

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 Linux timestamp of the date and time the session action was last updated.

progressPercent -> (float)

The percentage completed for a session action.

sessionId -> (string)

The session ID for the session action.

processExitCode -> (integer)

The exit code to exit the session.

progressMessage -> (string)

The message that communicates the progress of the session action.

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.

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.

syncInputJobAttachments -> (structure)

The job attachments to sync with a session action.

stepId -> (string)

The step ID for the step in the job attachment.