describeAnalysis method

Future<DescribeAnalysisResponse> describeAnalysis({ required String analysisId, required String awsAccountId, })

Provides a summary of the metadata for an analysis.

May throw InvalidParameterValueException. May throw ResourceNotFoundException. May throw AccessDeniedException. May throw ThrottlingException. May throw UnsupportedUserEditionException. May throw InternalFailureException.

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

Parameter awsAccountId : The ID of the AWS account that contains the analysis. You must be using the AWS account that the analysis is in.

Implementation

Future<DescribeAnalysisResponse> describeAnalysis({
  required String analysisId,
  required String awsAccountId,
}) async {
  ArgumentError.checkNotNull(analysisId, 'analysisId');
  _s.validateStringLength(
    'analysisId',
    analysisId,
    1,
    2048,
    isRequired: true,
  );
  ArgumentError.checkNotNull(awsAccountId, 'awsAccountId');
  _s.validateStringLength(
    'awsAccountId',
    awsAccountId,
    12,
    12,
    isRequired: true,
  );
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/accounts/${Uri.encodeComponent(awsAccountId)}/analyses/${Uri.encodeComponent(analysisId)}',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeAnalysisResponse.fromJson(response);
}