Skip to content

describe_export

Operation

describe_export

describe_export(request: DescribeExportInput | DescribeExportInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeExportInputDict]) -> DescribeExportOutput

Describes an existing table export.

Parameters:

Name Type Description Default
request DescribeExportInput | DescribeExportInputDict | 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[DescribeExportInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeExportOutput

An instance of DescribeExportOutput.

describe_export async

describe_export(request: DescribeExportInput | DescribeExportInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeExportInputDict]) -> DescribeExportOutput

Describes an existing table export.

Parameters:

Name Type Description Default
request DescribeExportInput | DescribeExportInputDict | 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[DescribeExportInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeExportOutput

An instance of DescribeExportOutput.

Input

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

DescribeExportInputDict

Bases: TypedDict

Dictionary form of DescribeExportInput.

Attributes

export_arn instance-attribute
export_arn: Required[str]

The Amazon Resource Name (ARN) associated with the export.

DescribeExportInput dataclass

Bases: _SerdeShape

Dataclass for DescribeExportInput structure.

Attributes

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

The Amazon Resource Name (ARN) associated with the export.

Output

DescribeExportOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeExportOutput structure.

Attributes

export_description class-attribute instance-attribute
export_description: ExportDescription | None = ...

Represents the properties of the export.

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.