QuickSight / Client / describe_analysis_definition

describe_analysis_definition#

QuickSight.Client.describe_analysis_definition(**kwargs)#

Provides a detailed description of the definition of an analysis.

Note

If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.

See also: AWS API Documentation

Request Syntax

response = client.describe_analysis_definition(
    AwsAccountId='string',
    AnalysisId='string'
)
Parameters:
  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

  • AnalysisId (string) –

    [REQUIRED]

    The ID of the analysis that you’re describing. The ID is part of the URL of the analysis.

Return type:

dict

Returns:

Response Syntax

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Response Structure

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Exceptions

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.ResourceExistsException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.ConflictException

  • QuickSight.Client.exceptions.UnsupportedUserEditionException

  • QuickSight.Client.exceptions.InternalFailureException