| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.QuickSight.DescribeAnalysis
Description
Provides a summary of the metadata for an analysis.
Synopsis
- data DescribeAnalysis = DescribeAnalysis' {
- awsAccountId :: Text
- analysisId :: Text
- newDescribeAnalysis :: Text -> Text -> DescribeAnalysis
- describeAnalysis_awsAccountId :: Lens' DescribeAnalysis Text
- describeAnalysis_analysisId :: Lens' DescribeAnalysis Text
- data DescribeAnalysisResponse = DescribeAnalysisResponse' {}
- newDescribeAnalysisResponse :: Int -> DescribeAnalysisResponse
- describeAnalysisResponse_requestId :: Lens' DescribeAnalysisResponse (Maybe Text)
- describeAnalysisResponse_analysis :: Lens' DescribeAnalysisResponse (Maybe Analysis)
- describeAnalysisResponse_status :: Lens' DescribeAnalysisResponse Int
Creating a Request
data DescribeAnalysis Source #
See: newDescribeAnalysis smart constructor.
Constructors
| DescribeAnalysis' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeAnalysis |
Create a value of DescribeAnalysis with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:awsAccountId:DescribeAnalysis', describeAnalysis_awsAccountId - 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.
$sel:analysisId:DescribeAnalysis', describeAnalysis_analysisId - The ID of the analysis that you're describing. The ID is part of the
URL of the analysis.
Request Lenses
describeAnalysis_awsAccountId :: Lens' DescribeAnalysis Text Source #
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.
describeAnalysis_analysisId :: Lens' DescribeAnalysis Text Source #
The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
Destructuring the Response
data DescribeAnalysisResponse Source #
See: newDescribeAnalysisResponse smart constructor.
Constructors
| DescribeAnalysisResponse' | |
Instances
newDescribeAnalysisResponse Source #
Create a value of DescribeAnalysisResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:requestId:DescribeAnalysisResponse', describeAnalysisResponse_requestId - The Amazon Web Services request ID for this operation.
$sel:analysis:DescribeAnalysisResponse', describeAnalysisResponse_analysis - A metadata structure that contains summary information for the analysis
that you're describing.
$sel:status:DescribeAnalysisResponse', describeAnalysisResponse_status - The HTTP status of the request.
Response Lenses
describeAnalysisResponse_requestId :: Lens' DescribeAnalysisResponse (Maybe Text) Source #
The Amazon Web Services request ID for this operation.
describeAnalysisResponse_analysis :: Lens' DescribeAnalysisResponse (Maybe Analysis) Source #
A metadata structure that contains summary information for the analysis that you're describing.
describeAnalysisResponse_status :: Lens' DescribeAnalysisResponse Int Source #
The HTTP status of the request.