DescribeTypeCommand

Suggest an Edit

Returns detailed information about an extension that has been registered.

If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CloudFormationClient, DescribeTypeCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
// const { CloudFormationClient, DescribeTypeCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
const client = new CloudFormationClient(config);
const input = { // DescribeTypeInput
  Type: "RESOURCE" || "MODULE" || "HOOK",
  TypeName: "STRING_VALUE",
  Arn: "STRING_VALUE",
  VersionId: "STRING_VALUE",
  PublisherId: "STRING_VALUE",
  PublicVersionNumber: "STRING_VALUE",
};
const command = new DescribeTypeCommand(input);
const response = await client.send(command);
// { // DescribeTypeOutput
//   Arn: "STRING_VALUE",
//   Type: "RESOURCE" || "MODULE" || "HOOK",
//   TypeName: "STRING_VALUE",
//   DefaultVersionId: "STRING_VALUE",
//   IsDefaultVersion: true || false,
//   TypeTestsStatus: "PASSED" || "FAILED" || "IN_PROGRESS" || "NOT_TESTED",
//   TypeTestsStatusDescription: "STRING_VALUE",
//   Description: "STRING_VALUE",
//   Schema: "STRING_VALUE",
//   ProvisioningType: "NON_PROVISIONABLE" || "IMMUTABLE" || "FULLY_MUTABLE",
//   DeprecatedStatus: "LIVE" || "DEPRECATED",
//   LoggingConfig: { // LoggingConfig
//     LogRoleArn: "STRING_VALUE", // required
//     LogGroupName: "STRING_VALUE", // required
//   },
//   RequiredActivatedTypes: [ // RequiredActivatedTypes
//     { // RequiredActivatedType
//       TypeNameAlias: "STRING_VALUE",
//       OriginalTypeName: "STRING_VALUE",
//       PublisherId: "STRING_VALUE",
//       SupportedMajorVersions: [ // SupportedMajorVersions
//         Number("int"),
//       ],
//     },
//   ],
//   ExecutionRoleArn: "STRING_VALUE",
//   Visibility: "PUBLIC" || "PRIVATE",
//   SourceUrl: "STRING_VALUE",
//   DocumentationUrl: "STRING_VALUE",
//   LastUpdated: new Date("TIMESTAMP"),
//   TimeCreated: new Date("TIMESTAMP"),
//   ConfigurationSchema: "STRING_VALUE",
//   PublisherId: "STRING_VALUE",
//   OriginalTypeName: "STRING_VALUE",
//   OriginalTypeArn: "STRING_VALUE",
//   PublicVersionNumber: "STRING_VALUE",
//   LatestPublicVersion: "STRING_VALUE",
//   IsActivated: true || false,
//   AutoUpdate: true || false,
// };

DescribeTypeCommand Input

See DescribeTypeCommandInput for more details

Parameter
Type
Description
Arn
string | undefined

The Amazon Resource Name (ARN) of the extension.

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

PublicVersionNumber
string | undefined

The version number of a public third-party extension.

PublisherId
string | undefined

The publisher ID of the extension publisher.

Extensions provided by Amazon Web Services are not assigned a publisher ID.

Type
RegistryType | undefined

The kind of extension.

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

TypeName
string | undefined

The name of the extension.

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

VersionId
string | undefined

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

DescribeTypeCommand Output

See DescribeTypeCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Arn
string | undefined

The Amazon Resource Name (ARN) of the extension.

AutoUpdate
boolean | undefined

Whether CloudFormation automatically updates the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Automatically use new versions of extensions  in the CloudFormation User Guide.

ConfigurationSchema
string | undefined

A JSON string that represent the current configuration data for the extension in this account and Region.

To set the configuration data for an extension, use SetTypeConfiguration . For more information, see Edit configuration data for extensions in your account  in the CloudFormation User Guide.

DefaultVersionId
string | undefined

The ID of the default version of the extension. The default version is used when the extension version isn't specified.

This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType .

To set the default version of an extension, use SetTypeDefaultVersion.

DeprecatedStatus
DeprecatedStatus | undefined

The deprecation status of the extension version.

Valid values include:

  • LIVE: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

  • DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.

For public third-party extensions, CloudFormation returns null.

Description
string | undefined

The description of the extension.

DocumentationUrl
string | undefined

The URL of a page providing detailed documentation for this extension.

ExecutionRoleArn
string | undefined

The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType .

If the registered extension calls any Amazon Web Services APIs, you must create an IAM execution role  that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.

IsActivated
boolean | undefined

Whether the extension is activated in the account and Region.

This only applies to public third-party extensions. For all other extensions, CloudFormation returns null.

IsDefaultVersion
boolean | undefined

Whether the specified extension version is set as the default version.

This applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation returns null.

LastUpdated
Date | undefined

When the specified extension version was registered. This applies only to:

  • Private extensions you have registered in your account. For more information, see RegisterType .

  • Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType .

LatestPublicVersion
string | undefined

The latest version of a public extension that is available for use.

This only applies if you specify a public extension, and you don't specify a version. For all other requests, CloudFormation returns null.

LoggingConfig
LoggingConfig | undefined

Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType .

OriginalTypeArn
string | undefined

For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.

OriginalTypeName
string | undefined

For public extensions that have been activated for this account and Region, the type name of the public extension.

If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Use aliases to refer to extensions  in the CloudFormation User Guide.

ProvisioningType
ProvisioningType | undefined

For resource type extensions, the provisioning behavior of the resource type. 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 resource type includes an update handler to process updates to the type during stack update operations.

  • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

  • NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.

    • create

    • read

    • delete

PublicVersionNumber
string | undefined

The version number of a public third-party extension.

This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null.

PublisherId
string | undefined

The publisher ID of the extension publisher.

This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon Web Services, CloudFormation returns null.

RequiredActivatedTypes
RequiredActivatedType[] | undefined

For extensions that are modules, the public third-party extensions that must be activated in your account in order for the module itself to be activated.

Schema
string | undefined

The schema that defines the extension.

For more information about extension schemas, see Resource type schema  in the CloudFormation Command Line Interface (CLI) User Guide.

SourceUrl
string | undefined

The URL of the source code for the extension.

TimeCreated
Date | undefined

When the specified private extension version was registered or activated in your account.

Type
RegistryType | undefined

The kind of extension.

TypeName
string | undefined

The name of the extension.

If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType .

TypeTestsStatus
TypeTestsStatus | undefined

The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

  • PASSED: The extension has passed all its contract tests.

    An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use  in the CloudFormation Command Line Interface (CLI) User Guide.

  • FAILED: The extension has failed one or more contract tests.

  • IN_PROGRESS: Contract tests are currently being performed on the extension.

  • NOT_TESTED: Contract tests haven't been performed on the extension.

TypeTestsStatusDescription
string | undefined

The description of the test status. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

Visibility
Visibility | undefined

The scope at which the extension is visible and usable in CloudFormation operations.

Valid values include:

  • PRIVATE: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register as PRIVATE.

  • PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.

Throws

Name
Fault
Details
CFNRegistryException
client

An error occurred during a CloudFormation registry operation.

TypeNotFoundException
client

The specified extension doesn't exist in the CloudFormation registry.

CloudFormationServiceException
Base exception class for all service exceptions from CloudFormation service.