Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. location
  5. getPlaceIndex
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.location.getPlaceIndex

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Retrieve information about a Location Service Place Index.

Example Usage

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

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

example = aws.location.get_place_index(index_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.LookupPlaceIndex(ctx, &location.LookupPlaceIndexArgs{
			IndexName: "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.GetPlaceIndex.Invoke(new()
    {
        IndexName = "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.GetPlaceIndexArgs;
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.getPlaceIndex(GetPlaceIndexArgs.builder()
            .indexName("example")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:location:getPlaceIndex
      arguments:
        indexName: example
Copy

Using getPlaceIndex

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 getPlaceIndex(args: GetPlaceIndexArgs, opts?: InvokeOptions): Promise<GetPlaceIndexResult>
function getPlaceIndexOutput(args: GetPlaceIndexOutputArgs, opts?: InvokeOptions): Output<GetPlaceIndexResult>
Copy
def get_place_index(index_name: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    opts: Optional[InvokeOptions] = None) -> GetPlaceIndexResult
def get_place_index_output(index_name: Optional[pulumi.Input[str]] = None,
                    tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetPlaceIndexResult]
Copy
func LookupPlaceIndex(ctx *Context, args *LookupPlaceIndexArgs, opts ...InvokeOption) (*LookupPlaceIndexResult, error)
func LookupPlaceIndexOutput(ctx *Context, args *LookupPlaceIndexOutputArgs, opts ...InvokeOption) LookupPlaceIndexResultOutput
Copy

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

public static class GetPlaceIndex 
{
    public static Task<GetPlaceIndexResult> InvokeAsync(GetPlaceIndexArgs args, InvokeOptions? opts = null)
    public static Output<GetPlaceIndexResult> Invoke(GetPlaceIndexInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPlaceIndexResult> getPlaceIndex(GetPlaceIndexArgs args, InvokeOptions options)
public static Output<GetPlaceIndexResult> getPlaceIndex(GetPlaceIndexArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:location/getPlaceIndex:getPlaceIndex
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

IndexName This property is required. string
Name of the place index resource.
Tags Dictionary<string, string>
Key-value map of resource tags for the place index.
IndexName This property is required. string
Name of the place index resource.
Tags map[string]string
Key-value map of resource tags for the place index.
indexName This property is required. String
Name of the place index resource.
tags Map<String,String>
Key-value map of resource tags for the place index.
indexName This property is required. string
Name of the place index resource.
tags {[key: string]: string}
Key-value map of resource tags for the place index.
index_name This property is required. str
Name of the place index resource.
tags Mapping[str, str]
Key-value map of resource tags for the place index.
indexName This property is required. String
Name of the place index resource.
tags Map<String>
Key-value map of resource tags for the place index.

getPlaceIndex Result

The following output properties are available:

CreateTime string
Timestamp for when the place index resource was created in ISO 8601 format.
DataSource string
Data provider of geospatial data.
DataSourceConfigurations List<GetPlaceIndexDataSourceConfiguration>
List of configurations that specify data storage option for requesting Places.
Description string
Optional description for the place index resource.
Id string
The provider-assigned unique ID for this managed resource.
IndexArn string
ARN for the place index resource.
IndexName string
Tags Dictionary<string, string>
Key-value map of resource tags for the place index.
UpdateTime string
Timestamp for when the place index resource was last updated in ISO 8601 format.
CreateTime string
Timestamp for when the place index resource was created in ISO 8601 format.
DataSource string
Data provider of geospatial data.
DataSourceConfigurations []GetPlaceIndexDataSourceConfiguration
List of configurations that specify data storage option for requesting Places.
Description string
Optional description for the place index resource.
Id string
The provider-assigned unique ID for this managed resource.
IndexArn string
ARN for the place index resource.
IndexName string
Tags map[string]string
Key-value map of resource tags for the place index.
UpdateTime string
Timestamp for when the place index resource was last updated in ISO 8601 format.
createTime String
Timestamp for when the place index resource was created in ISO 8601 format.
dataSource String
Data provider of geospatial data.
dataSourceConfigurations List<GetPlaceIndexDataSourceConfiguration>
List of configurations that specify data storage option for requesting Places.
description String
Optional description for the place index resource.
id String
The provider-assigned unique ID for this managed resource.
indexArn String
ARN for the place index resource.
indexName String
tags Map<String,String>
Key-value map of resource tags for the place index.
updateTime String
Timestamp for when the place index resource was last updated in ISO 8601 format.
createTime string
Timestamp for when the place index resource was created in ISO 8601 format.
dataSource string
Data provider of geospatial data.
dataSourceConfigurations GetPlaceIndexDataSourceConfiguration[]
List of configurations that specify data storage option for requesting Places.
description string
Optional description for the place index resource.
id string
The provider-assigned unique ID for this managed resource.
indexArn string
ARN for the place index resource.
indexName string
tags {[key: string]: string}
Key-value map of resource tags for the place index.
updateTime string
Timestamp for when the place index resource was last updated in ISO 8601 format.
create_time str
Timestamp for when the place index resource was created in ISO 8601 format.
data_source str
Data provider of geospatial data.
data_source_configurations Sequence[GetPlaceIndexDataSourceConfiguration]
List of configurations that specify data storage option for requesting Places.
description str
Optional description for the place index resource.
id str
The provider-assigned unique ID for this managed resource.
index_arn str
ARN for the place index resource.
index_name str
tags Mapping[str, str]
Key-value map of resource tags for the place index.
update_time str
Timestamp for when the place index resource was last updated in ISO 8601 format.
createTime String
Timestamp for when the place index resource was created in ISO 8601 format.
dataSource String
Data provider of geospatial data.
dataSourceConfigurations List<Property Map>
List of configurations that specify data storage option for requesting Places.
description String
Optional description for the place index resource.
id String
The provider-assigned unique ID for this managed resource.
indexArn String
ARN for the place index resource.
indexName String
tags Map<String>
Key-value map of resource tags for the place index.
updateTime String
Timestamp for when the place index resource was last updated in ISO 8601 format.

Supporting Types

GetPlaceIndexDataSourceConfiguration

IntendedUse This property is required. string
IntendedUse This property is required. string
intendedUse This property is required. String
intendedUse This property is required. string
intended_use This property is required. str
intendedUse This property is required. String

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws