list-types¶

Description¶

Returns summary information about types that have been registered with CloudFormation.

Synopsis¶

  list-types
[--visibility <value>]
[--provisioning-type <value>]
[--deprecated-status <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--visibility (string)

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 as PRIVATE .

PUBLIC : The type is publically visible and usable within any Amazon account.

The default is PRIVATE .

Possible values:

PUBLIC

PRIVATE

--provisioning-type (string)

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.

Possible values:

NON_PROVISIONABLE

IMMUTABLE

FULLY_MUTABLE

--deprecated-status (string)

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.

Possible values:

LIVE

DEPRECATED

--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 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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To list the private resource types in an account

The following list-types example displays a list of the private resource types currently registered in the current AWS account.

aws cloudformation list-types

Output:

{
    "TypeSummaries": [
        {
            "Description": "WordPress blog resource for internal use",
            "LastUpdated": "2019-12-04T18:28:15.059Z",
            "TypeName": "My::WordPress::BlogExample",
            "TypeArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-WordPress-BlogExample",
            "DefaultVersionId": "00000005",
            "Type": "RESOURCE"
        },
        {
            "Description": "Customized resource derived from AWS::Logs::LogGroup",
            "LastUpdated": "2019-12-04T18:28:15.059Z",
            "TypeName": "My::Logs::LogGroup",
            "TypeArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup",
            "DefaultVersionId": "00000003",
            "Type": "RESOURCE"
        }
    ]
}

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

Output¶

TypeSummaries -> (list)

A list of TypeSummary structures that contain information about the specified types.

(structure)

Contains summary information about the specified CloudFormation type.

Type -> (string)

The kind of type.

TypeName -> (string)

The name of the type.

DefaultVersionId -> (string)

The ID of the default version of the type. The default version is used when the type version is not specified.

To set the default version of a type, use `` SetTypeDefaultVersion `` .

TypeArn -> (string)

The Amazon Resource Name (ARN) of the type.

LastUpdated -> (timestamp)

When the current default version of the type was registered.

Description -> (string)

The description of the type.

NextToken -> (string)

If the request doesn’t return all of 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 .

Table of Contents

Feedback

User Guide