/
api_op_GetFaceSearch.go
139 lines (120 loc) · 5.9 KB
/
api_op_GetFaceSearch.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
// Code generated by smithy-go-codegen DO NOT EDIT.
package rekognition
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/rekognition/types"
"github.com/awslabs/smithy-go/middleware"
smithyhttp "github.com/awslabs/smithy-go/transport/http"
)
// Gets the face search results for Amazon Rekognition Video face search started by
// StartFaceSearch. The search returns faces in a collection that match the faces
// of persons detected in a video. It also includes the time(s) that faces are
// matched in the video. Face search in a video is an asynchronous operation. You
// start face search by calling to StartFaceSearch which returns a job identifier
// (JobId). When the search operation finishes, Amazon Rekognition Video publishes
// a completion status to the Amazon Simple Notification Service topic registered
// in the initial call to StartFaceSearch. To get the search results, first check
// that the status value published to the Amazon SNS topic is SUCCEEDED. If so,
// call GetFaceSearch and pass the job identifier (JobId) from the initial call to
// StartFaceSearch. For more information, see Searching Faces in a Collection in
// the Amazon Rekognition Developer Guide. The search results are retured in an
// array, Persons, of PersonMatch objects. EachPersonMatch element contains details
// about the matching faces in the input collection, person information (facial
// attributes, bounding boxes, and person identifer) for the matched person, and
// the time the person was matched in the video. GetFaceSearch only returns the
// default
//
// facial attributes (BoundingBox, Confidence, Landmarks, Pose, and
// Quality). The other facial attributes listed in the Face object of the following
// response syntax are not returned. For more information, see FaceDetail in the
// Amazon Rekognition Developer Guide. By default, the Persons array is sorted by
// the time, in milliseconds from the start of the video, persons are matched. You
// can also sort by persons by specifying INDEX for the SORTBY input parameter.
func (c *Client) GetFaceSearch(ctx context.Context, params *GetFaceSearchInput, optFns ...func(*Options)) (*GetFaceSearchOutput, error) {
if params == nil {
params = &GetFaceSearchInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetFaceSearch", params, optFns, addOperationGetFaceSearchMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetFaceSearchOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetFaceSearchInput struct {
// The job identifer for the search request. You get the job identifier from an
// initial call to StartFaceSearch.
//
// This member is required.
JobId *string
// Maximum number of results to return per paginated call. The largest value you
// can specify is 1000. If you specify a value greater than 1000, a maximum of 1000
// results is returned. The default value is 1000.
MaxResults *int32
// If the previous response was incomplete (because there is more search results to
// retrieve), Amazon Rekognition Video returns a pagination token in the response.
// You can use this pagination token to retrieve the next set of search results.
NextToken *string
// Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by
// the time that they are recognized. Use INDEX to sort by recognized faces.
SortBy types.FaceSearchSortBy
}
type GetFaceSearchOutput struct {
// The current status of the face search job.
JobStatus types.VideoJobStatus
// 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 search
// results.
NextToken *string
// An array of persons, PersonMatch, in the video whose face(s) match the face(s)
// in an Amazon Rekognition collection. It also includes time information for when
// persons are matched in the video. You specify the input collection in an initial
// call to StartFaceSearch. Each Persons element includes a time the person was
// matched, face match details (FaceMatches) for matching faces in the collection,
// and person information (Person) for the matched person.
Persons []*types.PersonMatch
// If the job fails, StatusMessage provides a descriptive error message.
StatusMessage *string
// Information about a video that Amazon Rekognition analyzed. Videometadata is
// returned in every page of paginated responses from a Amazon Rekognition Video
// operation.
VideoMetadata *types.VideoMetadata
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
}
func addOperationGetFaceSearchMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetFaceSearch{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetFaceSearch{}, middleware.After)
if err != nil {
return err
}
awsmiddleware.AddRequestInvocationIDMiddleware(stack)
smithyhttp.AddContentLengthMiddleware(stack)
addResolveEndpointMiddleware(stack, options)
v4.AddComputePayloadSHA256Middleware(stack)
addRetryMiddlewares(stack, options)
addHTTPSignerV4Middleware(stack, options)
awsmiddleware.AddAttemptClockSkewMiddleware(stack)
addClientUserAgent(stack)
smithyhttp.AddErrorCloseResponseBodyMiddleware(stack)
smithyhttp.AddCloseResponseBodyMiddleware(stack)
addOpGetFaceSearchValidationMiddleware(stack)
stack.Initialize.Add(newServiceMetadataMiddleware_opGetFaceSearch(options.Region), middleware.Before)
addRequestIDRetrieverMiddleware(stack)
addResponseErrorMiddleware(stack)
return nil
}
func newServiceMetadataMiddleware_opGetFaceSearch(region string) awsmiddleware.RegisterServiceMetadata {
return awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "rekognition",
OperationName: "GetFaceSearch",
}
}