ListTypes - AWS CloudFormation

ListTypes

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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

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.

Type: String

Valid Values: LIVE | DEPRECATED

Required: No

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

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.

Type: String

Valid Values: NON_PROVISIONABLE | IMMUTABLE | FULLY_MUTABLE

Required: No

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

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

The default is PRIVATE.

Type: String

Valid Values: PUBLIC | PRIVATE

Required: No

Response Elements

The following elements are returned by the service.

NextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

TypeSummaries.member.N

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

Type: Array of TypeSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

CFNRegistry

An error occurred during a CloudFormation registry operation.

HTTP Status Code: 400

Example

ListTypes

the following example returns summary information for all the private resource types registered in this AWS account.

Sample Request

https://cloudformation.us-east-1.amazonaws.com/ ?Action=ListTypes &Version=2010-05-15 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=[Access key ID and scope] &X-Amz-Date=20191204T183443Z &X-Amz-SignedHeaders=content-type;host &X-Amz-Signature=[Signature]

Sample Response

<ListTypesResult> <TypeSummaries> <member> <LastUpdated>2019-12-04T18:28:15.059Z</LastUpdated> <DefaultVersionId>00000003</DefaultVersionId> <TypeArn>arn:aws:cloudformation:us-east-1:012345678910:type/resource/My-Resource-Example</TypeArn> <TypeName>My::Resource::Example</TypeName> <Description>Resource schema for My::Resource::Example</Description> <Type>RESOURCE</Type> </member> <member> <LastUpdated>2019-12-04T18:28:15.059Z</LastUpdated> <DefaultVersionId>00000001</DefaultVersionId> <TypeArn>arn:aws:cloudformation:us-east-1:012345678910:type/resource/My-Second-Example</TypeArn> <TypeName>My::Second::Example</TypeName> <Description>Resource schema for My::Second::Example</Description> <Type>RESOURCE</Type> </member> </TypeSummaries> </ListTypesResult> <ResponseMetadata> <RequestId>69dc5a34-5462-4e1b-81fb-7a310example</RequestId> </ResponseMetadata> </ListTypesResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: