QuickSight / Client / describe_space

describe_space

QuickSight.Client.describe_space(**kwargs)

Describes an Amazon QuickSight space.

See also: AWS API Documentation

Request Syntax

response = client.describe_space(
    AwsAccountId='string',
    SpaceId='string',
    MaxContributors=123
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

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

  • SpaceId (string) –

    [REQUIRED]

    The ID of the space that you want to describe.

  • MaxContributors (integer) – The maximum number of contributors to include in the response.

Return type:

dict

Returns:

Response Syntax

{
    'spaceId': 'string',
    'spaceArn': 'string',
    'Space': {
        'name': 'string',
        'description': 'string',
        'resources': [
            {
                'resourceType': 'TOPIC'|'DASHBOARD'|'KNOWLEDGE_BASE'|'SPACE'|'ACTION_CONNECTOR'|'DATA_SET'|'ARTIFACT',
                'resourceDetails': {
                    'resourceArn': 'string'
                }
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'consumedSourceSize': 123,
        'consumedSourceDocCount': 123,
        'createdBy': 'string',
        'createdByArn': 'string'
    },
    'Contributors': [
        {
            'userName': 'string',
            'rawFileSizeBytes': 123,
            'percentage': 123.0
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • spaceId (string) –

      The ID of the space.

    • spaceArn (string) –

      The ARN of the space.

    • Space (dict) –

      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.

        • (dict) –

          A QuickSight resource that is associated with a space.

          • resourceType (string) –

            The type of the QuickSight resource.

          • resourceDetails (dict) –

            The details of the QuickSight resource.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: resourceArn. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

            • resourceArn (string) –

              The ARN of the QuickSight resource.

      • createdAt (datetime) –

        The date and time that the space was created.

      • updatedAt (datetime) –

        The date and time that the space was last updated.

      • consumedSourceSize (integer) –

        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.

      • (dict) –

        A contributor to an Amazon QuickSight space.

        • userName (string) –

          The user name of the contributor.

        • rawFileSizeBytes (integer) –

          The raw file size in bytes contributed by the user.

        • percentage (float) –

          The percentage of total contributions made by the user.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions