Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141341,3811.0 MB

Provides a detailed description of the definition of an analysis.

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.

get/accounts/{AwsAccountId}/analyses/{AnalysisId}/definition

Path parameters

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

AnalysisIdstring required

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

Response

Success

AnalysisIdstring

The ID of the analysis described.

Namestring

The descriptive name of the analysis.

ResourceStatus'CREATION_IN_PROGRESS' | 'CREATION_SUCCESSFUL' | 'CREATION_FAILED' | 'UPDATE_IN_PROGRESS' | 'UPDATE_SUCCESSFUL' | 'UPDATE_FAILED' | 'DELETED'
<p>Status associated with the analysis.</p> <ul> <li> <p> <code>CREATION_IN_PROGRESS</code> </p> </li> <li> <p> <code>CREATION_SUCCESSFUL</code> </p> </li> <li> <p> <code>CREATION_FAILED</code> </p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> </p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> </p> </li> <li> <p> <code>UPDATE_FAILED</code> </p> </li> <li> <p> <code>DELETED</code> </p> </li> </ul>
ThemeArnstring

The ARN of the theme of the analysis.

Statusinteger

The HTTP status of the request.

RequestIdstring

The Amazon Web Services request ID for this operation.