1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rekognition
  5. getCollection

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.rekognition.getCollection

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

The AWS::Rekognition::Collection type creates an Amazon Rekognition Collection. A collection is a logical grouping of information about detected faces which can later be referenced for searches on the group

Using getCollection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCollection(args: GetCollectionArgs, opts?: InvokeOptions): Promise<GetCollectionResult>
function getCollectionOutput(args: GetCollectionOutputArgs, opts?: InvokeOptions): Output<GetCollectionResult>
Copy
def get_collection(collection_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetCollectionResult
def get_collection_output(collection_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetCollectionResult]
Copy
func LookupCollection(ctx *Context, args *LookupCollectionArgs, opts ...InvokeOption) (*LookupCollectionResult, error)
func LookupCollectionOutput(ctx *Context, args *LookupCollectionOutputArgs, opts ...InvokeOption) LookupCollectionResultOutput
Copy

> Note: This function is named LookupCollection in the Go SDK.

public static class GetCollection 
{
    public static Task<GetCollectionResult> InvokeAsync(GetCollectionArgs args, InvokeOptions? opts = null)
    public static Output<GetCollectionResult> Invoke(GetCollectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCollectionResult> getCollection(GetCollectionArgs args, InvokeOptions options)
public static Output<GetCollectionResult> getCollection(GetCollectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:rekognition:getCollection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CollectionId This property is required. string
ID for the collection that you are creating.
CollectionId This property is required. string
ID for the collection that you are creating.
collectionId This property is required. String
ID for the collection that you are creating.
collectionId This property is required. string
ID for the collection that you are creating.
collection_id This property is required. str
ID for the collection that you are creating.
collectionId This property is required. String
ID for the collection that you are creating.

getCollection Result

The following output properties are available:

Arn string
Returns the Amazon Resource Name of the collection.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this resource.
Arn string
Returns the Amazon Resource Name of the collection.
Tags Tag
An array of key-value pairs to apply to this resource.
arn String
Returns the Amazon Resource Name of the collection.
tags List<Tag>
An array of key-value pairs to apply to this resource.
arn string
Returns the Amazon Resource Name of the collection.
tags Tag[]
An array of key-value pairs to apply to this resource.
arn str
Returns the Amazon Resource Name of the collection.
tags Sequence[root_Tag]
An array of key-value pairs to apply to this resource.
arn String
Returns the Amazon Resource Name of the collection.
tags List<Property Map>
An array of key-value pairs to apply to this resource.

Supporting Types

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi