QuickSight / Client / describe_quick_sight_q_search_configuration

describe_quick_sight_q_search_configuration

QuickSight.Client.describe_quick_sight_q_search_configuration(**kwargs)

Describes the state of a Amazon QuickSight Q Search configuration.

See also: AWS API Documentation

Request Syntax

response = client.describe_quick_sight_q_search_configuration(
    AwsAccountId='string'
)

Parameters:

AwsAccountId (string) –

[REQUIRED]

The ID of the Amazon Web Services account that contains the Amazon QuickSight Q Search configuration that the user wants described.

Return type:

dict

Returns:

Response Syntax

{
    'QSearchStatus': 'ENABLED'|'DISABLED',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) –

  • QSearchStatus (string) –

    The status of Amazon QuickSight Q Search configuration.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.

  • Status (integer) –

    The HTTP status of the request.

Exceptions

• QuickSight.Client.exceptions.AccessDeniedException

• QuickSight.Client.exceptions.ConflictException

• QuickSight.Client.exceptions.InvalidParameterValueException

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.ResourceNotFoundException

• QuickSight.Client.exceptions.InternalFailureException