Rekognition / Client / list_stream_processors

list_stream_processors

Rekognition.Client.list_stream_processors(**kwargs)

Gets a list of stream processors that you have created with CreateStreamProcessor.

See also: AWS API Documentation

Request Syntax

response = client.list_stream_processors(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of stream processors.

  • MaxResults (integer) – Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'StreamProcessors': [
        {
            'Name': 'string',
            'Status': 'STOPPED'|'STARTING'|'RUNNING'|'FAILED'|'STOPPING'|'UPDATING'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of stream processors.

    • StreamProcessors (list) –

      List of stream processors that you have created.

      • (dict) –

        An object that recognizes faces or labels in a streaming video. An Amazon Rekognition stream processor is created by a call to CreateStreamProcessor. The request parameters for CreateStreamProcessor describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.

        • Name (string) –

          Name of the Amazon Rekognition stream processor.

        • Status (string) –

          Current status of the Amazon Rekognition stream processor.

Exceptions