Gets the ImageGenerationConfiguration for a given Kinesis video stream.
Parameters:
-
stream_name
(Optional[StreamName], default:
None
)
–
The name of the stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.
-
stream_arn
(Optional[ResourceARN], default:
None
)
–
The Amazon Resource Name (ARN) of the Kinesis video stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.
Raises:
Source code in docs_src/capo_kinesis_video/_services/kinesis_video.py
| def describe_image_generation_configuration(
self,
*,
config_overrides: Optional[KinesisVideoClientConfig] = None,
stream_name: Optional["capo_kinesis_video.types.stream_name.StreamName"] = None,
stream_arn: Optional[
"capo_kinesis_video.types.resource_arn.ResourceARN"
] = None,
) -> "capo_kinesis_video.types.describe_image_generation_configuration_output.DescribeImageGenerationConfigurationOutput":
"""<p>Gets the <code>ImageGenerationConfiguration</code> for a given Kinesis video stream.</p>
Args:
stream_name: <p>The name of the stream from which to retrieve the image generation configuration. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>. </p>
stream_arn: <p>The Amazon Resource Name (ARN) of the Kinesis video stream from which to retrieve the image generation configuration. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>.</p>
Raises:
capo_kinesis_video.errors.access_denied_exception.AccessDeniedException: <p>You do not have required permissions to perform this operation.</p>
capo_kinesis_video.errors.client_limit_exceeded_exception.ClientLimitExceededException: <p>Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.</p>
capo_kinesis_video.errors.invalid_argument_exception.InvalidArgumentException: <p>The value for this input parameter is invalid.</p>
capo_kinesis_video.errors.resource_not_found_exception.ResourceNotFoundException: <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
capo_kinesis_video.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_kinesis_video.types.describe_image_generation_configuration_input.DescribeImageGenerationConfigurationInput]",
) -> OperationResponse[
"capo_kinesis_video.types.describe_image_generation_configuration_output.DescribeImageGenerationConfigurationOutput"
]:
import capo_kinesis_video._operations.kinesis_video_20170930.describe_image_generation_configuration
output, http_response = (
capo_kinesis_video._operations.kinesis_video_20170930.describe_image_generation_configuration.describe_image_generation_configuration(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeImageGenerationConfiguration")
)
input_: capo_kinesis_video.types.describe_image_generation_configuration_input.DescribeImageGenerationConfigurationInput = {}
if stream_name is not None:
input_["stream_name"] = stream_name
if stream_arn is not None:
input_["stream_arn"] = stream_arn
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|