Skip to content

describe_kinesis_streaming_destination

Operation

describe_kinesis_streaming_destination

Returns information about the status of Kinesis streaming.

Parameters:

Name Type Description Default
request DescribeKinesisStreamingDestinationInput | DescribeKinesisStreamingDestinationInputDict | 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[DescribeKinesisStreamingDestinationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeKinesisStreamingDestinationOutput

An instance of DescribeKinesisStreamingDestinationOutput.

describe_kinesis_streaming_destination async

Returns information about the status of Kinesis streaming.

Parameters:

Name Type Description Default
request DescribeKinesisStreamingDestinationInput | DescribeKinesisStreamingDestinationInputDict | 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[DescribeKinesisStreamingDestinationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeKinesisStreamingDestinationOutput

An instance of DescribeKinesisStreamingDestinationOutput.

Input

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

DescribeKinesisStreamingDestinationInputDict

Bases: TypedDict

Dictionary form of DescribeKinesisStreamingDestinationInput.

Attributes

table_name instance-attribute
table_name: Required[str]

The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

DescribeKinesisStreamingDestinationInput dataclass

Bases: _SerdeShape

Dataclass for DescribeKinesisStreamingDestinationInput structure.

Attributes

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

The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Output

DescribeKinesisStreamingDestinationOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeKinesisStreamingDestinationOutput structure.

Attributes

kinesis_data_stream_destinations class-attribute instance-attribute
kinesis_data_stream_destinations: list[KinesisDataStreamDestination] | None = ...

The list of replica structures for the table being described.

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.

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

The name of the table being described.