/AWS1/CL_REK=>GETSEGMENTDETECTION()
¶
About GetSegmentDetection¶
Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.
Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by
calling StartSegmentDetection which returns a job identifier (JobId
).
When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service
topic registered in the initial call to StartSegmentDetection
. To get the results
of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
.
if so, call GetSegmentDetection
and pass the job identifier (JobId
) from the initial call
of StartSegmentDetection
.
GetSegmentDetection
returns detected segments in an array (Segments
)
of SegmentDetection objects. Segments
is sorted by the segment types
specified in the SegmentTypes
input parameter of StartSegmentDetection
.
Each element of the array includes the detected segment, the precentage confidence in the acuracy
of the detected segment, the type of the segment, and the frame in which the segment was detected.
Use SelectedSegmentTypes
to find out the type of segment detection requested in the
call to StartSegmentDetection
.
Use the MaxResults
parameter to limit the number of segment detections returned. If there are more results than
specified in MaxResults
, the value of NextToken
in the operation response contains
a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection
and populate the NextToken
request parameter with the token value returned from the previous
call to GetSegmentDetection
.
For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_JOBID
TYPE /AWS1/REKJOBID
/AWS1/REKJOBID
¶
Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to
StartSegmentDetection
.
Optional arguments:¶
IV_MAXRESULTS
TYPE /AWS1/REKMAXRESULTS
/AWS1/REKMAXRESULTS
¶
Maximum number of results to return per paginated call. The largest value you can specify is 1000.
IV_NEXTTOKEN
TYPE /AWS1/REKPAGINATIONTOKEN
/AWS1/REKPAGINATIONTOKEN
¶
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 text.