1. Packages
  2. AWS
  3. API Docs
  4. location
  5. getGeofenceCollection
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi

aws.location.getGeofenceCollection

Explore with Pulumi AI

Retrieve information about a Location Service Geofence Collection.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.location.getGeofenceCollection({
    collectionName: "example",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.location.get_geofence_collection(collection_name="example")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/location"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := location.LookupGeofenceCollection(ctx, &location.LookupGeofenceCollectionArgs{
			CollectionName: "example",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Location.GetGeofenceCollection.Invoke(new()
    {
        CollectionName = "example",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.location.LocationFunctions;
import com.pulumi.aws.location.inputs.GetGeofenceCollectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = LocationFunctions.getGeofenceCollection(GetGeofenceCollectionArgs.builder()
            .collectionName("example")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:location:getGeofenceCollection
      arguments:
        collectionName: example
Copy

Using getGeofenceCollection

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 getGeofenceCollection(args: GetGeofenceCollectionArgs, opts?: InvokeOptions): Promise<GetGeofenceCollectionResult>
function getGeofenceCollectionOutput(args: GetGeofenceCollectionOutputArgs, opts?: InvokeOptions): Output<GetGeofenceCollectionResult>
Copy
def get_geofence_collection(collection_name: Optional[str] = None,
                            kms_key_id: Optional[str] = None,
                            tags: Optional[Mapping[str, str]] = None,
                            opts: Optional[InvokeOptions] = None) -> GetGeofenceCollectionResult
def get_geofence_collection_output(collection_name: Optional[pulumi.Input[str]] = None,
                            kms_key_id: Optional[pulumi.Input[str]] = None,
                            tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetGeofenceCollectionResult]
Copy
func LookupGeofenceCollection(ctx *Context, args *LookupGeofenceCollectionArgs, opts ...InvokeOption) (*LookupGeofenceCollectionResult, error)
func LookupGeofenceCollectionOutput(ctx *Context, args *LookupGeofenceCollectionOutputArgs, opts ...InvokeOption) LookupGeofenceCollectionResultOutput
Copy

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

public static class GetGeofenceCollection 
{
    public static Task<GetGeofenceCollectionResult> InvokeAsync(GetGeofenceCollectionArgs args, InvokeOptions? opts = null)
    public static Output<GetGeofenceCollectionResult> Invoke(GetGeofenceCollectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGeofenceCollectionResult> getGeofenceCollection(GetGeofenceCollectionArgs args, InvokeOptions options)
public static Output<GetGeofenceCollectionResult> getGeofenceCollection(GetGeofenceCollectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:location/getGeofenceCollection:getGeofenceCollection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CollectionName This property is required. string
Name of the geofence collection.
KmsKeyId string
Key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
Tags Dictionary<string, string>
Key-value map of resource tags for the geofence collection.
CollectionName This property is required. string
Name of the geofence collection.
KmsKeyId string
Key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
Tags map[string]string
Key-value map of resource tags for the geofence collection.
collectionName This property is required. String
Name of the geofence collection.
kmsKeyId String
Key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
tags Map<String,String>
Key-value map of resource tags for the geofence collection.
collectionName This property is required. string
Name of the geofence collection.
kmsKeyId string
Key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
tags {[key: string]: string}
Key-value map of resource tags for the geofence collection.
collection_name This property is required. str
Name of the geofence collection.
kms_key_id str
Key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
tags Mapping[str, str]
Key-value map of resource tags for the geofence collection.
collectionName This property is required. String
Name of the geofence collection.
kmsKeyId String
Key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
tags Map<String>
Key-value map of resource tags for the geofence collection.

getGeofenceCollection Result

The following output properties are available:

CollectionArn string
ARN for the geofence collection resource. Used when you need to specify a resource across all AWS.
CollectionName string
CreateTime string
Timestamp for when the geofence collection resource was created in ISO 8601 format.
Description string
Optional description of the geofence collection resource.
Id string
The provider-assigned unique ID for this managed resource.
KmsKeyId string
Key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
Tags Dictionary<string, string>
Key-value map of resource tags for the geofence collection.
UpdateTime string
Timestamp for when the geofence collection resource was last updated in ISO 8601 format.
CollectionArn string
ARN for the geofence collection resource. Used when you need to specify a resource across all AWS.
CollectionName string
CreateTime string
Timestamp for when the geofence collection resource was created in ISO 8601 format.
Description string
Optional description of the geofence collection resource.
Id string
The provider-assigned unique ID for this managed resource.
KmsKeyId string
Key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
Tags map[string]string
Key-value map of resource tags for the geofence collection.
UpdateTime string
Timestamp for when the geofence collection resource was last updated in ISO 8601 format.
collectionArn String
ARN for the geofence collection resource. Used when you need to specify a resource across all AWS.
collectionName String
createTime String
Timestamp for when the geofence collection resource was created in ISO 8601 format.
description String
Optional description of the geofence collection resource.
id String
The provider-assigned unique ID for this managed resource.
kmsKeyId String
Key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
tags Map<String,String>
Key-value map of resource tags for the geofence collection.
updateTime String
Timestamp for when the geofence collection resource was last updated in ISO 8601 format.
collectionArn string
ARN for the geofence collection resource. Used when you need to specify a resource across all AWS.
collectionName string
createTime string
Timestamp for when the geofence collection resource was created in ISO 8601 format.
description string
Optional description of the geofence collection resource.
id string
The provider-assigned unique ID for this managed resource.
kmsKeyId string
Key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
tags {[key: string]: string}
Key-value map of resource tags for the geofence collection.
updateTime string
Timestamp for when the geofence collection resource was last updated in ISO 8601 format.
collection_arn str
ARN for the geofence collection resource. Used when you need to specify a resource across all AWS.
collection_name str
create_time str
Timestamp for when the geofence collection resource was created in ISO 8601 format.
description str
Optional description of the geofence collection resource.
id str
The provider-assigned unique ID for this managed resource.
kms_key_id str
Key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
tags Mapping[str, str]
Key-value map of resource tags for the geofence collection.
update_time str
Timestamp for when the geofence collection resource was last updated in ISO 8601 format.
collectionArn String
ARN for the geofence collection resource. Used when you need to specify a resource across all AWS.
collectionName String
createTime String
Timestamp for when the geofence collection resource was created in ISO 8601 format.
description String
Optional description of the geofence collection resource.
id String
The provider-assigned unique ID for this managed resource.
kmsKeyId String
Key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
tags Map<String>
Key-value map of resource tags for the geofence collection.
updateTime String
Timestamp for when the geofence collection resource was last updated in ISO 8601 format.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.