Skip to content

describe_stream_processor async

describe_stream_processor(
    name: StreamProcessorName,
    *,
    config_overrides: Optional[AsyncRekognitionClientConfig] = None,
) -> DescribeStreamProcessorResponse

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.

Parameters:

Raises:

Source code in docs_src/capo_rekognition/_services/async_rekognition.py
async def describe_stream_processor(
    self,
    name: "capo_rekognition.types.stream_processor_name.StreamProcessorName",
    *,
    config_overrides: Optional[AsyncRekognitionClientConfig] = None,
) -> "capo_rekognition.types.describe_stream_processor_response.DescribeStreamProcessorResponse":
    """<important> <p>Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/rekognition-availability-changes.html">Rekognition feature availability changes</a>.</p> <p> <b>This change does not impact the availability of other Amazon Rekognition features.</b> </p> </important> <p>Provides information about a stream processor created by <a>CreateStreamProcessor</a>. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.</p>

    Args:
        name: <p>Name of the stream processor for which you want information.</p>

    Raises:
        capo_rekognition.errors.access_denied_exception.AccessDeniedException: <p>You are not authorized to perform the action.</p>
        capo_rekognition.errors.internal_server_error.InternalServerError: <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
        capo_rekognition.errors.invalid_parameter_exception.InvalidParameterException: <p>Input parameter violated a constraint. Validate your parameter before calling the API operation again.</p>
        capo_rekognition.errors.provisioned_throughput_exceeded_exception.ProvisionedThroughputExceededException: <p>The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.</p>
        capo_rekognition.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource specified in the request cannot be found.</p>
        capo_rekognition.errors.throttling_exception.ThrottlingException: <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
        capo_rekognition.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_rekognition.types.describe_stream_processor_request.DescribeStreamProcessorRequest]",
    ) -> AsyncOperationResponse[
        "capo_rekognition.types.describe_stream_processor_response.DescribeStreamProcessorResponse"
    ]:
        import capo_rekognition._operations.rekognition_service.describe_stream_processor

        (
            output,
            http_response,
        ) = await capo_rekognition._operations.rekognition_service.describe_stream_processor.async_describe_stream_processor(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeStreamProcessor")
    )
    input_: capo_rekognition.types.describe_stream_processor_request.DescribeStreamProcessorRequest = {
        "name": name
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output