CloudFormation / Client / deregister_type

deregister_type#

CloudFormation.Client.deregister_type(**kwargs)#

Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.

To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.

You can’t deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.

To view the deprecation status of an extension or extension version, use DescribeType.

See also: AWS API Documentation

Request Syntax

response = client.deregister_type(
    Arn='string',
    Type='RESOURCE'|'MODULE'|'HOOK',
    TypeName='string',
    VersionId='string'
)
Parameters:

  • Arn (string) –

    The Amazon Resource Name (ARN) of the extension.

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

  • Type (string) –

    The kind of extension.

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

  • TypeName (string) –

    The name of the extension.

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

  • VersionId (string) – 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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • CloudFormation.Client.exceptions.CFNRegistryException

  • CloudFormation.Client.exceptions.TypeNotFoundException