describeObjects method

Future<DescribeObjectsOutput> describeObjects({ required List<String> objectIds, required String pipelineId, bool? evaluateExpressions, String? marker, })

Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.

May throw InternalServiceError. May throw InvalidRequestException. May throw PipelineNotFoundException. May throw PipelineDeletedException.

Parameter objectIds : The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Parameter pipelineId : The ID of the pipeline that contains the object definitions.

Parameter evaluateExpressions : Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

Parameter marker : The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call DescribeObjects with the marker value from the previous call to retrieve the next set of results.

Implementation

Future<DescribeObjectsOutput> describeObjects({
  required List<String> objectIds,
  required String pipelineId,
  bool? evaluateExpressions,
  String? marker,
}) async {
  ArgumentError.checkNotNull(objectIds, 'objectIds');
  ArgumentError.checkNotNull(pipelineId, 'pipelineId');
  _s.validateStringLength(
    'pipelineId',
    pipelineId,
    1,
    1024,
    isRequired: true,
  );
  _s.validateStringLength(
    'marker',
    marker,
    0,
    1024,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'DataPipeline.DescribeObjects'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'objectIds': objectIds,
      'pipelineId': pipelineId,
      if (evaluateExpressions != null)
        'evaluateExpressions': evaluateExpressions,
      if (marker != null) 'marker': marker,
    },
  );

  return DescribeObjectsOutput.fromJson(jsonResponse.body);
}