aws_sdk_rekognition/client/
describe_collection.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeCollection`](crate::operation::describe_collection::builders::DescribeCollectionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`collection_id(impl Into<String>)`](crate::operation::describe_collection::builders::DescribeCollectionFluentBuilder::collection_id) / [`set_collection_id(Option<String>)`](crate::operation::describe_collection::builders::DescribeCollectionFluentBuilder::set_collection_id):<br>required: **true**<br><p>The ID of the collection to describe.</p><br>
7    /// - On success, responds with [`DescribeCollectionOutput`](crate::operation::describe_collection::DescribeCollectionOutput) with field(s):
8    ///   - [`face_count(Option<i64>)`](crate::operation::describe_collection::DescribeCollectionOutput::face_count): <p>The number of faces that are indexed into the collection. To index faces into a collection, use <code>IndexFaces</code>.</p>
9    ///   - [`face_model_version(Option<String>)`](crate::operation::describe_collection::DescribeCollectionOutput::face_model_version): <p>The version of the face model that's used by the collection for face detection.</p> <p>For more information, see Model versioning in the Amazon Rekognition Developer Guide.</p>
10    ///   - [`collection_arn(Option<String>)`](crate::operation::describe_collection::DescribeCollectionOutput::collection_arn): <p>The Amazon Resource Name (ARN) of the collection.</p>
11    ///   - [`creation_timestamp(Option<DateTime>)`](crate::operation::describe_collection::DescribeCollectionOutput::creation_timestamp): <p>The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.</p>
12    ///   - [`user_count(Option<i64>)`](crate::operation::describe_collection::DescribeCollectionOutput::user_count): <p>The number of UserIDs assigned to the specified colleciton.</p>
13    /// - On failure, responds with [`SdkError<DescribeCollectionError>`](crate::operation::describe_collection::DescribeCollectionError)
14    pub fn describe_collection(&self) -> crate::operation::describe_collection::builders::DescribeCollectionFluentBuilder {
15        crate::operation::describe_collection::builders::DescribeCollectionFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_rekognition/client/describe_collection.rs

aws_sdk_rekognition/client/
describe_collection.rs
