describeRecord method

Future<DescribeRecordOutput> describeRecord({
  1. required String id,
  2. String? acceptLanguage,
  3. int? pageSize,
  4. String? pageToken,
})

Gets information about the specified request operation.

Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

May throw ResourceNotFoundException.

Parameter id : The record identifier of the provisioned product. This identifier is returned by the request operation.

Parameter acceptLanguage : The language code.

  • en - English (default)
  • jp - Japanese
  • zh - Chinese

Parameter pageSize : The maximum number of items to return with this call.

Parameter pageToken : The page token for the next set of results. To retrieve the first set of results, use null.

Implementation

Future<DescribeRecordOutput> describeRecord({
  required String id,
  String? acceptLanguage,
  int? pageSize,
  String? pageToken,
}) async {
  ArgumentError.checkNotNull(id, 'id');
  _s.validateStringLength(
    'id',
    id,
    1,
    100,
    isRequired: true,
  );
  _s.validateStringLength(
    'acceptLanguage',
    acceptLanguage,
    0,
    100,
  );
  _s.validateNumRange(
    'pageSize',
    pageSize,
    0,
    20,
  );
  _s.validateStringLength(
    'pageToken',
    pageToken,
    0,
    2024,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWS242ServiceCatalogService.DescribeRecord'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Id': id,
      if (acceptLanguage != null) 'AcceptLanguage': acceptLanguage,
      if (pageSize != null) 'PageSize': pageSize,
      if (pageToken != null) 'PageToken': pageToken,
    },
  );

  return DescribeRecordOutput.fromJson(jsonResponse.body);
}