Skip to content

describe_type

Operation

describe_type

describe_type(request: DescribeTypeInput | DescribeTypeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTypeInputDict]) -> DescribeTypeOutput

Returns detailed information about an extension from the CloudFormation registry in your current account and Region.

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

For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.

Parameters:

Name Type Description Default
request DescribeTypeInput | DescribeTypeInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeTypeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeTypeOutput

An instance of DescribeTypeOutput.

describe_type async

describe_type(request: DescribeTypeInput | DescribeTypeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTypeInputDict]) -> DescribeTypeOutput

Returns detailed information about an extension from the CloudFormation registry in your current account and Region.

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

For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.

Parameters:

Name Type Description Default
request DescribeTypeInput | DescribeTypeInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeTypeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeTypeOutput

An instance of DescribeTypeOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeTypeInputDict

Bases: TypedDict

Dictionary form of DescribeTypeInput.

Attributes

arn instance-attribute
arn: str | None

The Amazon Resource Name (ARN) of the extension.

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

public_version_number instance-attribute
public_version_number: str | None

The version number of a public third-party extension.

publisher_id instance-attribute
publisher_id: str | None

The publisher ID of the extension publisher.

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

type instance-attribute
type: str | None

The kind of extension.

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

type_name instance-attribute
type_name: str | None

The name of the extension.

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

version_id instance-attribute
version_id: str | None

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.

DescribeTypeInput dataclass

Bases: _SerdeShape

Dataclass for DescribeTypeInput structure.

Attributes

arn class-attribute instance-attribute
arn: str | None = ...

The Amazon Resource Name (ARN) of the extension.

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

public_version_number class-attribute instance-attribute
public_version_number: str | None = ...

The version number of a public third-party extension.

publisher_id class-attribute instance-attribute
publisher_id: str | None = ...

The publisher ID of the extension publisher.

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

type class-attribute instance-attribute
type: str | None = ...

The kind of extension.

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

type_name class-attribute instance-attribute
type_name: str | None = ...

The name of the extension.

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

version_id class-attribute instance-attribute
version_id: str | None = ...

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.

Output

DescribeTypeOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeTypeOutput structure.

Attributes

arn class-attribute instance-attribute
arn: str | None = ...

The Amazon Resource Name (ARN) of the extension.

auto_update class-attribute instance-attribute
auto_update: bool | None = ...

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.

configuration_schema class-attribute instance-attribute
configuration_schema: str | None = ...

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.

default_version_id class-attribute instance-attribute
default_version_id: str | None = ...

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.

deprecated_status class-attribute instance-attribute
deprecated_status: str | None = ...

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 class-attribute instance-attribute
description: str | None = ...

The description of the extension.

documentation_url class-attribute instance-attribute
documentation_url: str | None = ...

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

execution_role_arn class-attribute instance-attribute
execution_role_arn: str | None = ...

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.

is_activated class-attribute instance-attribute
is_activated: bool | None = ...

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.

is_default_version class-attribute instance-attribute
is_default_version: bool | None = ...

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.

last_updated class-attribute instance-attribute
last_updated: datetime | None = ...

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.

latest_public_version class-attribute instance-attribute
latest_public_version: str | None = ...

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.

logging_config class-attribute instance-attribute
logging_config: LoggingConfig | None = ...

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.

original_type_arn class-attribute instance-attribute
original_type_arn: str | None = ...

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

original_type_name class-attribute instance-attribute
original_type_name: str | None = ...

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.

provisioning_type class-attribute instance-attribute
provisioning_type: str | None = ...

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

public_version_number class-attribute instance-attribute
public_version_number: str | None = ...

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.

publisher_id class-attribute instance-attribute
publisher_id: str | None = ...

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.

required_activated_types class-attribute instance-attribute
required_activated_types: list[RequiredActivatedType] | None = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

schema class-attribute instance-attribute
schema: str | None = ...

The schema that defines the extension.

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

source_url class-attribute instance-attribute
source_url: str | None = ...

The URL of the source code for the extension.

time_created class-attribute instance-attribute
time_created: datetime | None = ...

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

type class-attribute instance-attribute
type: str | None = ...

The kind of extension.

type_name class-attribute instance-attribute
type_name: str | None = ...

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.

type_tests_status class-attribute instance-attribute
type_tests_status: str | None = ...

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.

type_tests_status_description class-attribute instance-attribute
type_tests_status_description: str | None = ...

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 class-attribute instance-attribute
visibility: str | None = ...

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.