Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cloudformation ]

list-type-registrations

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-type-registrations
[--type <value>]
[--type-name <value>]
[--type-arn <value>]
[--registration-status-filter <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--type (string)

The kind of extension.

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

Possible values:

  • RESOURCE
  • MODULE
  • HOOK

--type-name (string)

The name of the extension.

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

--type-arn (string)

The Amazon Resource Name (ARN) of the extension.

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

--registration-status-filter (string)

The current status of the extension registration request.

The default is IN_PROGRESS .

Possible values:

  • COMPLETE
  • IN_PROGRESS
  • FAILED

--max-results (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.

--next-token (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 .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list the completed registrations of a type

The following list-type-registrations example displays a list of the completed type registrations for the specified type.

aws cloudformation list-type-registrations \
    --type RESOURCE \
    --type-name My::Logs::LogGroup \
    --registration-status-filter COMPLETE

Output:

{
    "RegistrationTokenList": [
        "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
        "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"
    ]
}

For more information, see Using the CloudFormation Registry in the AWS CloudFormation Users Guide.

Output

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 .