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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.rekognition.getCollection

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 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>
    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]
    func LookupCollection(ctx *Context, args *LookupCollectionArgs, opts ...InvokeOption) (*LookupCollectionResult, error)
    func LookupCollectionOutput(ctx *Context, args *LookupCollectionOutputArgs, opts ...InvokeOption) LookupCollectionResultOutput

    > 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)
    }
    public static CompletableFuture<GetCollectionResult> getCollection(GetCollectionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:rekognition:getCollection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CollectionId string
    ID for the collection that you are creating.
    CollectionId string
    ID for the collection that you are creating.
    collectionId String
    ID for the collection that you are creating.
    collectionId string
    ID for the collection that you are creating.
    collection_id str
    ID for the collection that you are creating.
    collectionId 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 string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi