deregister_type¶
Operation¶
deregister_type
¶
deregister_type(request: DeregisterTypeInput | DeregisterTypeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeregisterTypeInputDict]) -> DeregisterTypeOutput
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.
For more information, see Remove third-party private extensions from your account in the CloudFormation User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeregisterTypeInput | DeregisterTypeInputDict | 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[DeregisterTypeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeregisterTypeOutput
|
An instance of |
deregister_type
async
¶
deregister_type(request: DeregisterTypeInput | DeregisterTypeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeregisterTypeInputDict]) -> DeregisterTypeOutput
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.
For more information, see Remove third-party private extensions from your account in the CloudFormation User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeregisterTypeInput | DeregisterTypeInputDict | 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[DeregisterTypeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeregisterTypeOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DeregisterTypeInputDict
¶
Bases: TypedDict
Dictionary form of DeregisterTypeInput.
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.
type
instance-attribute
¶
type: str | None
The kind of extension.
Conditional: You must specify either TypeName and Type, or Arn.
DeregisterTypeInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeregisterTypeInput 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.
type
class-attribute
instance-attribute
¶
type: str | None = ...
The kind of extension.
Conditional: You must specify either TypeName and Type, or Arn.
Output¶
DeregisterTypeOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeregisterTypeOutput structure.