Skip to content

update_max_record_size

Operation

update_max_record_size

update_max_record_size(request: UpdateMaxRecordSizeInput | UpdateMaxRecordSizeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateMaxRecordSizeInputDict]) -> UpdateMaxRecordSizeOutput

This allows you to update the MaxRecordSize of a single record that you can write to, and read from a stream. You can ingest and digest single records up to 10240 KiB.

Parameters:

Name Type Description Default
request UpdateMaxRecordSizeInput | UpdateMaxRecordSizeInputDict | 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[UpdateMaxRecordSizeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateMaxRecordSizeOutput

An instance of UpdateMaxRecordSizeOutput.

update_max_record_size async

update_max_record_size(request: UpdateMaxRecordSizeInput | UpdateMaxRecordSizeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateMaxRecordSizeInputDict]) -> UpdateMaxRecordSizeOutput

This allows you to update the MaxRecordSize of a single record that you can write to, and read from a stream. You can ingest and digest single records up to 10240 KiB.

Parameters:

Name Type Description Default
request UpdateMaxRecordSizeInput | UpdateMaxRecordSizeInputDict | 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[UpdateMaxRecordSizeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateMaxRecordSizeOutput

An instance of UpdateMaxRecordSizeOutput.

Input

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

UpdateMaxRecordSizeInputDict

Bases: TypedDict

Dictionary form of UpdateMaxRecordSizeInput.

Attributes

max_record_size_in_ki_b instance-attribute
max_record_size_in_ki_b: Required[int]

The maximum record size of a single record in KiB that you can write to, and read from a stream. Specify a value between 1024 and 10240 KiB (1 to 10 MiB). If you specify a value that is out of this range, UpdateMaxRecordSize sends back an ValidationException message.

stream_arn instance-attribute
stream_arn: str | None

The Amazon Resource Name (ARN) of the stream for the MaxRecordSize update.

stream_id instance-attribute
stream_id: str | None

Not Implemented. Reserved for future use.

UpdateMaxRecordSizeInput dataclass

Bases: _SerdeShape

Dataclass for UpdateMaxRecordSizeInput structure.

Attributes

max_record_size_in_ki_b class-attribute instance-attribute
max_record_size_in_ki_b: int | None = ...

The maximum record size of a single record in KiB that you can write to, and read from a stream. Specify a value between 1024 and 10240 KiB (1 to 10 MiB). If you specify a value that is out of this range, UpdateMaxRecordSize sends back an ValidationException message.

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

The Amazon Resource Name (ARN) of the stream for the MaxRecordSize update.

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

Not Implemented. Reserved for future use.

Output

UpdateMaxRecordSizeOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateMaxRecordSizeOutput structure.

Attributes

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.