listObjectChildren method

Future<ListObjectChildrenResponse> listObjectChildren({ required String directoryArn, required ObjectReference objectReference, ConsistencyLevel? consistencyLevel, int? maxResults, String? nextToken, })

Returns a paginated list of child objects that are associated with a given object.

May throw InternalServiceException. May throw InvalidArnException. May throw RetryableConflictException. May throw ValidationException. May throw LimitExceededException. May throw AccessDeniedException. May throw DirectoryNotEnabledException. May throw ResourceNotFoundException. May throw InvalidNextTokenException. May throw NotNodeException.

Parameter directoryArn : The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

Parameter objectReference : The reference that identifies the object for which child objects are being listed.

Parameter consistencyLevel : Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

Parameter maxResults : The maximum number of items to be retrieved in a single call. This is an approximate number.

Parameter nextToken : The pagination token.

Implementation

Future<ListObjectChildrenResponse> listObjectChildren({
  required String directoryArn,
  required ObjectReference objectReference,
  ConsistencyLevel? consistencyLevel,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(directoryArn, 'directoryArn');
  ArgumentError.checkNotNull(objectReference, 'objectReference');
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    1152921504606846976,
  );
  final headers = <String, String>{
    'x-amz-data-partition': directoryArn.toString(),
    if (consistencyLevel != null)
      'x-amz-consistency-level': consistencyLevel.toValue(),
  };
  final $payload = <String, dynamic>{
    'ObjectReference': objectReference,
    if (maxResults != null) 'MaxResults': maxResults,
    if (nextToken != null) 'NextToken': nextToken,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/amazonclouddirectory/2017-01-11/object/children',
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
  return ListObjectChildrenResponse.fromJson(response);
}