AWS CLI Command Reference

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 . workspaces-web ]

get-session-logger

Description

Gets details about a specific session logger resource.

See also: AWS API Documentation

Synopsis

  get-session-logger
--session-logger-arn <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

--session-logger-arn (string)

The ARN of the session logger.

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

sessionLogger -> (structure)

The session logger details.

sessionLoggerArn -> (string)

The ARN of the session logger resource.

eventFilter -> (tagged union structure)

The filter that specifies which events to monitor.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: all, include.

all -> (structure)

The filter that monitors all of the available events, including any new events emitted in the future.

include -> (list)

The filter that monitors only the listed set of events. New events are not auto-monitored.

(string)

logConfiguration -> (structure)

The configuration that specifies where logs are fowarded.

s3 -> (structure)

The configuration for delivering the logs to S3.

bucket -> (string)

The S3 bucket name where logs are delivered.

keyPrefix -> (string)

The S3 path prefix that determines where log files are stored.

bucketOwner -> (string)

The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket.

logFileFormat -> (string)

The format of the LogFile that is written to S3.

folderStructure -> (string)

The folder structure that defines the organizational structure for log files in S3.

customerManagedKey -> (string)

The custom managed key of the session logger.

additionalEncryptionContext -> (map)

The additional encryption context of the session logger.

key -> (string)

value -> (string)

associatedPortalArns -> (list)

The associated portal ARN.

(string)

displayName -> (string)

The human-readable display name.

creationDate -> (timestamp)

The date the session logger resource was created.