[ aws . amp ]

describe-workspace

Description

Describes an existing AMP workspace.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--workspace-id (string)

The ID of the workspace to describe.

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

See ‘aws help’ for descriptions of global parameters.

Output

workspace -> (structure)

The properties of the selected workspace.

alias -> (string)

Alias of this workspace.

arn -> (string)

The Amazon Resource Name (ARN) of this workspace.

createdAt -> (timestamp)

The time when the workspace was created.

prometheusEndpoint -> (string)

Prometheus endpoint URI.

status -> (structure)

The status of this workspace.

statusCode -> (string)

Status code of this workspace.

workspaceId -> (string)

Unique string identifying this workspace.