listTypeVersions method

Future<ListTypeVersionsOutput> listTypeVersions({ String? arn, DeprecatedStatus? deprecatedStatus, int? maxResults, String? nextToken, RegistryType? type, String? typeName, })

Returns summary information about the versions of a type.

May throw CFNRegistryException.

Parameter arn : The Amazon Resource Name (ARN) of the type for which you want version summary information.

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

Parameter deprecatedStatus : The deprecation status of the type versions that you want to get summary information about.

Valid values include:

• LIVE: The type version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
• DEPRECATED: The type version has been deregistered and can no longer be used in CloudFormation operations.

The default is LIVE.

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 type : The kind of the type.

Currently the only valid value is RESOURCE.

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

Parameter typeName : The name of the type for which you want version summary information.

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

Implementation

Future<ListTypeVersionsOutput> listTypeVersions({
  String? arn,
  DeprecatedStatus? deprecatedStatus,
  int? maxResults,
  String? nextToken,
  RegistryType? type,
  String? typeName,
}) async {
  _s.validateStringLength(
    'arn',
    arn,
    0,
    1024,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    1,
    1024,
  );
  _s.validateStringLength(
    'typeName',
    typeName,
    10,
    204,
  );
  final $request = <String, dynamic>{};
  arn?.also((arg) => $request['Arn'] = arg);
  deprecatedStatus
      ?.also((arg) => $request['DeprecatedStatus'] = arg.toValue());
  maxResults?.also((arg) => $request['MaxResults'] = arg);
  nextToken?.also((arg) => $request['NextToken'] = arg);
  type?.also((arg) => $request['Type'] = arg.toValue());
  typeName?.also((arg) => $request['TypeName'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ListTypeVersions',
    version: '2010-05-15',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ListTypeVersionsInput'],
    shapes: shapes,
    resultWrapper: 'ListTypeVersionsResult',
  );
  return ListTypeVersionsOutput.fromXml($result);
}