listTypeRegistrations method

Future<ListTypeRegistrationsOutput> listTypeRegistrations({ int? maxResults, String? nextToken, RegistrationStatus? registrationStatusFilter, RegistryType? type, String? typeArn, String? typeName, })

Returns a list of registration tokens for the specified type(s).

May throw CFNRegistryException.

Parameter maxResults : The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Parameter nextToken : If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Parameter registrationStatusFilter : The current status of the type registration request.

The default is IN_PROGRESS.

Parameter type : The kind of type.

Currently the only valid value is RESOURCE.

Conditional: You must specify either TypeName and Type, or Arn.

Parameter typeArn : The Amazon Resource Name (ARN) of the type.

Conditional: You must specify either TypeName and Type, or Arn.

Parameter typeName : The name of the type.

Conditional: You must specify either TypeName and Type, or Arn.

Implementation

Future<ListTypeRegistrationsOutput> listTypeRegistrations({
  int? maxResults,
  String? nextToken,
  RegistrationStatus? registrationStatusFilter,
  RegistryType? type,
  String? typeArn,
  String? typeName,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    1,
    1024,
  );
  _s.validateStringLength(
    'typeArn',
    typeArn,
    0,
    1024,
  );
  _s.validateStringLength(
    'typeName',
    typeName,
    10,
    204,
  );
  final $request = <String, dynamic>{};
  maxResults?.also((arg) => $request['MaxResults'] = arg);
  nextToken?.also((arg) => $request['NextToken'] = arg);
  registrationStatusFilter
      ?.also((arg) => $request['RegistrationStatusFilter'] = arg.toValue());
  type?.also((arg) => $request['Type'] = arg.toValue());
  typeArn?.also((arg) => $request['TypeArn'] = arg);
  typeName?.also((arg) => $request['TypeName'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ListTypeRegistrations',
    version: '2010-05-15',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ListTypeRegistrationsInput'],
    shapes: shapes,
    resultWrapper: 'ListTypeRegistrationsResult',
  );
  return ListTypeRegistrationsOutput.fromXml($result);
}