describe_type_registration¶
Operation¶
describe_type_registration
¶
describe_type_registration(request: DescribeTypeRegistrationInput | DescribeTypeRegistrationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTypeRegistrationInputDict]) -> DescribeTypeRegistrationOutput
Returns information about an extension's registration, including its current status and type and version identifiers.
When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.
Once the registration request has completed, use DescribeType to return detailed information about an extension.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeTypeRegistrationInput | DescribeTypeRegistrationInputDict | 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[DescribeTypeRegistrationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeTypeRegistrationOutput
|
An instance of |
describe_type_registration
async
¶
describe_type_registration(request: DescribeTypeRegistrationInput | DescribeTypeRegistrationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTypeRegistrationInputDict]) -> DescribeTypeRegistrationOutput
Returns information about an extension's registration, including its current status and type and version identifiers.
When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.
Once the registration request has completed, use DescribeType to return detailed information about an extension.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeTypeRegistrationInput | DescribeTypeRegistrationInputDict | 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[DescribeTypeRegistrationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeTypeRegistrationOutput
|
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.
Output¶
DescribeTypeRegistrationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeTypeRegistrationOutput structure.
Attributes¶
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the extension registration request.
progress_status
class-attribute
instance-attribute
¶
progress_status: str | None = ...
The current status of the extension registration request.
response_metadata
class-attribute
instance-attribute
¶
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.