AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . quicksight ]

describe-space

Description

Describes an Amazon QuickSight space.

See also: AWS API Documentation

Synopsis

  describe-space
--aws-account-id <value>
--space-id <value>
[--max-contributors <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>]
[--v2-debug]

Options

--aws-account-id (string)

The ID of the Amazon Web Services account that contains the space.

--space-id (string)

The ID of the space that you want to describe.

--max-contributors (integer)

The maximum number of contributors to include in the response.

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

spaceId -> (string)

The ID of the space.

spaceArn -> (string)

The ARN of the space.

Space -> (structure)

The details of the space.

name -> (string)

The display name of the space.

description -> (string)

The description of the space.

resources -> (list)

The resources in the space.

(structure)

A QuickSight resource that is associated with a space.

resourceType -> (string)

The type of the QuickSight resource.

resourceDetails -> (tagged union structure)

The details of the QuickSight resource.

Note

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

resourceArn -> (string)

The ARN of the QuickSight resource.

createdAt -> (timestamp)

The date and time that the space was created.

updatedAt -> (timestamp)

The date and time that the space was last updated.

consumedSourceSize -> (long)

The total consumed source size in bytes.

consumedSourceDocCount -> (integer)

The number of consumed source documents.

createdBy -> (string)

The user who created the space.

createdByArn -> (string)

The ARN of the user who created the space.

Contributors -> (list)

A list of contributors to the space.

(structure)

A contributor to an Amazon QuickSight space.

userName -> (string)

The user name of the contributor.

rawFileSizeBytes -> (long)

The raw file size in bytes contributed by the user.

percentage -> (double)

The percentage of total contributions made by the user.

RequestId -> (string)

The Amazon Web Services request ID for this operation.