1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package rekognition
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/smithy-go/middleware"
10	smithyhttp "github.com/aws/smithy-go/transport/http"
11	"time"
12)
13
14// Describes the specified collection. You can use DescribeCollection to get
15// information, such as the number of faces indexed into a collection and the
16// version of the model used by the collection for face detection. For more
17// information, see Describing a Collection in the Amazon Rekognition Developer
18// Guide.
19func (c *Client) DescribeCollection(ctx context.Context, params *DescribeCollectionInput, optFns ...func(*Options)) (*DescribeCollectionOutput, error) {
20	if params == nil {
21		params = &DescribeCollectionInput{}
22	}
23
24	result, metadata, err := c.invokeOperation(ctx, "DescribeCollection", params, optFns, addOperationDescribeCollectionMiddlewares)
25	if err != nil {
26		return nil, err
27	}
28
29	out := result.(*DescribeCollectionOutput)
30	out.ResultMetadata = metadata
31	return out, nil
32}
33
34type DescribeCollectionInput struct {
35
36	// The ID of the collection to describe.
37	//
38	// This member is required.
39	CollectionId *string
40}
41
42type DescribeCollectionOutput struct {
43
44	// The Amazon Resource Name (ARN) of the collection.
45	CollectionARN *string
46
47	// The number of milliseconds since the Unix epoch time until the creation of the
48	// collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC),
49	// Thursday, 1 January 1970.
50	CreationTimestamp *time.Time
51
52	// The number of faces that are indexed into the collection. To index faces into a
53	// collection, use IndexFaces.
54	FaceCount *int64
55
56	// The version of the face model that's used by the collection for face detection.
57	// For more information, see Model Versioning in the Amazon Rekognition Developer
58	// Guide.
59	FaceModelVersion *string
60
61	// Metadata pertaining to the operation's result.
62	ResultMetadata middleware.Metadata
63}
64
65func addOperationDescribeCollectionMiddlewares(stack *middleware.Stack, options Options) (err error) {
66	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeCollection{}, middleware.After)
67	if err != nil {
68		return err
69	}
70	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeCollection{}, middleware.After)
71	if err != nil {
72		return err
73	}
74	if err = addSetLoggerMiddleware(stack, options); err != nil {
75		return err
76	}
77	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
78		return err
79	}
80	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
81		return err
82	}
83	if err = addResolveEndpointMiddleware(stack, options); err != nil {
84		return err
85	}
86	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
87		return err
88	}
89	if err = addRetryMiddlewares(stack, options); err != nil {
90		return err
91	}
92	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
93		return err
94	}
95	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
96		return err
97	}
98	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
99		return err
100	}
101	if err = addClientUserAgent(stack); err != nil {
102		return err
103	}
104	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
105		return err
106	}
107	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
108		return err
109	}
110	if err = addOpDescribeCollectionValidationMiddleware(stack); err != nil {
111		return err
112	}
113	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeCollection(options.Region), middleware.Before); err != nil {
114		return err
115	}
116	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
117		return err
118	}
119	if err = addResponseErrorMiddleware(stack); err != nil {
120		return err
121	}
122	if err = addRequestResponseLogging(stack, options); err != nil {
123		return err
124	}
125	return nil
126}
127
128func newServiceMetadataMiddleware_opDescribeCollection(region string) *awsmiddleware.RegisterServiceMetadata {
129	return &awsmiddleware.RegisterServiceMetadata{
130		Region:        region,
131		ServiceID:     ServiceID,
132		SigningName:   "rekognition",
133		OperationName: "DescribeCollection",
134	}
135}
136