[ aws . quicksight ]

describe-folder

Description

Describes a folder.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-folder
--aws-account-id <value>
--folder-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The AWS account ID.

--folder-id (string)

The folder ID.

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

Status -> (integer)

The status. If succeeded, the status is SC_OK (200) .

Folder -> (structure)

Information about the folder.

FolderId -> (string)

The folder ID.

Arn -> (string)

The folder Amazon Resource Name (ARN).

Name -> (string)

A display name for the folder.

FolderType -> (string)

The type of the folder.

FolderPath -> (list)

An array of ancestor folder ARN strings.

(string)

CreatedTime -> (timestamp)

The time that the folder was created.

LastUpdatedTime -> (timestamp)

The time that the folder was last updated.

RequestId -> (string)

The request ID.