update_max_record_size
¶
update_max_record_size(
max_record_size_in_ki_b: MaxRecordSizeInKiB,
*,
config_overrides: Optional[KinesisClientConfig] = None,
stream_arn: Optional[StreamARN] = None,
stream_id: Optional[StreamId] = None,
) -> None
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:
-
stream_arn(Optional[StreamARN], default:None) –The Amazon Resource Name (ARN) of the stream for the
MaxRecordSizeupdate. -
stream_id(Optional[StreamId], default:None) –Not Implemented. Reserved for future use.
-
max_record_size_in_ki_b(MaxRecordSizeInKiB) –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,
UpdateMaxRecordSizesends back anValidationExceptionmessage.
Raises:
-
AccessDeniedException–Specifies that you do not have the permissions required to perform this operation.
-
InvalidArgumentException–A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
-
LimitExceededException–The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
-
ResourceInUseException–The resource is not available for this operation. For successful operation, the resource must be in the
ACTIVEstate. -
ResourceNotFoundException–The requested resource could not be found. The stream might not be specified correctly.
-
ValidationException–Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode.
-
UnknownServiceError–The service returned an error code this client does not model.