AWS Native v0.63.0, May 25 23

aws-native.rekognition.getCollection

Explore with Pulumi AI

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

CollectionId string

collectionId String

collectionId string

collection_id str

collectionId String

getCollection Result

The following output properties are available:

Arn string
Tags List<Pulumi.AwsNative.Rekognition.Outputs.CollectionTag>: An array of key-value pairs to apply to this resource.

Arn string
Tags []CollectionTag: An array of key-value pairs to apply to this resource.

arn String
tags List<CollectionTag>: An array of key-value pairs to apply to this resource.

arn string
tags CollectionTag[]: An array of key-value pairs to apply to this resource.

arn str
tags Sequence[CollectionTag]: An array of key-value pairs to apply to this resource.

arn String
tags List<Property Map>: An array of key-value pairs to apply to this resource.

Supporting Types

CollectionTag

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

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