describe_folder

QuickSight.Client.describe_folder(**kwargs)

Describes a folder.

See also: AWS API Documentation

Request Syntax

response = client.describe_folder(
    AwsAccountId='string',
    FolderId='string'
)

Parameters

• AwsAccountId (string) --

  [REQUIRED]

  The ID for the Amazon Web Services account that contains the folder.

• FolderId (string) --

  [REQUIRED]

  The ID of the folder.

Return type

dict

Returns

Response Syntax

{
    'Status': 123,
    'Folder': {
        'FolderId': 'string',
        'Arn': 'string',
        'Name': 'string',
        'FolderType': 'SHARED',
        'FolderPath': [
            'string',
        ],
        'CreatedTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1)
    },
    'RequestId': 'string'
}

Response Structure

• (dict) --

  • Status (integer) --

    The HTTP status of the request.

  • Folder (dict) --

    Information about the folder.

    • FolderId (string) --

      The ID of the folder.

    • Arn (string) --

      The Amazon Resource Name (ARN) for the folder.

    • Name (string) --

      A display name for the folder.

    • FolderType (string) --

      The type of folder it is.

    • FolderPath (list) --

      An array of ancestor ARN strings for the folder.

      • (string) --

    • CreatedTime (datetime) --

      The time that the folder was created.

    • LastUpdatedTime (datetime) --

      The time that the folder was last updated.

  • RequestId (string) --

    The Amazon Web Services request ID for this operation.

Exceptions

• QuickSight.Client.exceptions.InvalidParameterValueException
• QuickSight.Client.exceptions.AccessDeniedException
• QuickSight.Client.exceptions.ResourceNotFoundException
• QuickSight.Client.exceptions.ThrottlingException
• QuickSight.Client.exceptions.UnsupportedUserEditionException
• QuickSight.Client.exceptions.InternalFailureException