listTypes method
- DeprecatedStatus? deprecatedStatus,
- int? maxResults,
- String? nextToken,
- ProvisioningType? provisioningType,
- RegistryType? type,
- Visibility? visibility,
Returns summary information about types that have been registered with CloudFormation.
May throw CFNRegistryException.
Parameter deprecatedStatus
:
The deprecation status of the types that you want to get summary
information about.
Valid values include:
-
LIVE
: The type is registered for use in CloudFormation operations. -
DEPRECATED
: The type has been deregistered and can no longer be used in CloudFormation operations.
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 provisioningType
:
The provisioning behavior of the type. AWS CloudFormation determines the
provisioning type during registration, based on the types of handlers in
the schema handler package submitted.
Valid values include:
-
FULLY_MUTABLE
: The type includes an update handler to process updates to the type during stack update operations. -
IMMUTABLE
: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations. -
NON_PROVISIONABLE
: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.
Parameter type
:
The type of extension.
Parameter visibility
:
The scope at which the type is visible and usable in CloudFormation
operations.
Valid values include:
-
PRIVATE
: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create asPRIVATE
. -
PUBLIC
: The type is publically visible and usable within any Amazon account.
PRIVATE
.
Implementation
Future<ListTypesOutput> listTypes({
DeprecatedStatus? deprecatedStatus,
int? maxResults,
String? nextToken,
ProvisioningType? provisioningType,
RegistryType? type,
Visibility? visibility,
}) async {
_s.validateNumRange(
'maxResults',
maxResults,
1,
100,
);
_s.validateStringLength(
'nextToken',
nextToken,
1,
1024,
);
final $request = <String, dynamic>{};
deprecatedStatus
?.also((arg) => $request['DeprecatedStatus'] = arg.toValue());
maxResults?.also((arg) => $request['MaxResults'] = arg);
nextToken?.also((arg) => $request['NextToken'] = arg);
provisioningType
?.also((arg) => $request['ProvisioningType'] = arg.toValue());
type?.also((arg) => $request['Type'] = arg.toValue());
visibility?.also((arg) => $request['Visibility'] = arg.toValue());
final $result = await _protocol.send(
$request,
action: 'ListTypes',
version: '2010-05-15',
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
shape: shapes['ListTypesInput'],
shapes: shapes,
resultWrapper: 'ListTypesResult',
);
return ListTypesOutput.fromXml($result);
}