describe_import¶
Operation¶
describe_import
¶
describe_import(request: DescribeImportInput | DescribeImportInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeImportInputDict]) -> DescribeImportOutput
Represents the properties of the import.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeImportInput | DescribeImportInputDict | 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[DescribeImportInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeImportOutput
|
An instance of |
describe_import
async
¶
describe_import(request: DescribeImportInput | DescribeImportInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeImportInputDict]) -> DescribeImportOutput
Represents the properties of the import.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeImportInput | DescribeImportInputDict | 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[DescribeImportInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeImportOutput
|
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¶
DescribeImportOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeImportOutput structure.
Attributes¶
import_table_description
instance-attribute
¶
import_table_description: ImportTableDescription
Represents the properties of the table created for the import, and parameters of the import. The import parameters include import status, how many items were processed, and how many errors were encountered.
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.