[ aws . amp ]

describe-logging-configuration

Description

Describes logging configuration.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-logging-configuration
--workspace-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--workspace-id (string)

The ID of the workspace to vend logs to.

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

See ‘aws help’ for descriptions of global parameters.

Output

loggingConfiguration -> (structure)

Metadata object containing information about the logging configuration of a workspace.

createdAt -> (timestamp)

The time when the logging configuration was created.

logGroupArn -> (string)

The ARN of the CW log group to which the vended log data will be published.

modifiedAt -> (timestamp)

The time when the logging configuration was modified.

status -> (structure)

The status of the logging configuration.

statusCode -> (string)

Status code of the logging configuration.

statusReason -> (string)

The reason for failure if any.

workspace -> (string)

The workspace where the logging configuration exists.