CloudFormation / Client / list_type_registrations

list_type_registrations#

CloudFormation.Client.list_type_registrations(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_type_registrations(
    Type='RESOURCE'|'MODULE'|'HOOK',
    TypeName='string',
    TypeArn='string',
    RegistrationStatusFilter='COMPLETE'|'IN_PROGRESS'|'FAILED',
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • Type (string) –

    The kind of extension.

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

  • TypeName (string) –

    The name of the extension.

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

  • TypeArn (string) –

    The Amazon Resource Name (ARN) of the extension.

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

  • RegistrationStatusFilter (string) –

    The current status of the extension registration request.

    The default is IN_PROGRESS.

  • MaxResults (integer) – 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.

  • NextToken (string) – If the previous paginated request didn’t return all 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.

Return type:

dict

Returns:

Response Syntax

{
    'RegistrationTokenList': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RegistrationTokenList (list) –

      A list of extension registration tokens.

      Use DescribeTypeRegistration to return detailed information about a type registration request.

      • (string) –

    • NextToken (string) –

      If the request doesn’t return all the remaining results, NextToken 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 the request returns all results, NextToken is set to null.

Exceptions

  • CloudFormation.Client.exceptions.CFNRegistryException