AWS v6.54.2 published on Wednesday, Oct 2, 2024 by Pulumi
aws.location.getPlaceIndex
Explore with Pulumi AI
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",
});
import pulumi
import pulumi_aws as aws
example = aws.location.get_place_index(index_name="example")
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
})
}
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",
});
});
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());
}
}
variables:
example:
fn::invoke:
Function: aws:location:getPlaceIndex
Arguments:
indexName: example
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>
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]
func LookupPlaceIndex(ctx *Context, args *LookupPlaceIndexArgs, opts ...InvokeOption) (*LookupPlaceIndexResult, error)
func LookupPlaceIndexOutput(ctx *Context, args *LookupPlaceIndexOutputArgs, opts ...InvokeOption) LookupPlaceIndexResultOutput
> 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)
}
public static CompletableFuture<GetPlaceIndexResult> getPlaceIndex(GetPlaceIndexArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:location/getPlaceIndex:getPlaceIndex
arguments:
# arguments dictionary
The following arguments are supported:
- Index
Name string - Name of the place index resource.
- Dictionary<string, string>
- Key-value map of resource tags for the place index.
- Index
Name string - Name of the place index resource.
- map[string]string
- Key-value map of resource tags for the place index.
- index
Name String - Name of the place index resource.
- Map<String,String>
- Key-value map of resource tags for the place index.
- index
Name string - Name of the place index resource.
- {[key: string]: string}
- Key-value map of resource tags for the place index.
- index_
name str - Name of the place index resource.
- Mapping[str, str]
- Key-value map of resource tags for the place index.
- index
Name String - Name of the place index resource.
- Map<String>
- Key-value map of resource tags for the place index.
getPlaceIndex Result
The following output properties are available:
- Create
Time string - Timestamp for when the place index resource was created in ISO 8601 format.
- Data
Source string - Data provider of geospatial data.
- Data
Source List<GetConfigurations Place Index Data Source Configuration> - 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.
- Index
Arn string - ARN for the place index resource.
- Index
Name string - Dictionary<string, string>
- Key-value map of resource tags for the place index.
- Update
Time string - Timestamp for when the place index resource was last updated in ISO 8601 format.
- Create
Time string - Timestamp for when the place index resource was created in ISO 8601 format.
- Data
Source string - Data provider of geospatial data.
- Data
Source []GetConfigurations Place Index Data Source Configuration - 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.
- Index
Arn string - ARN for the place index resource.
- Index
Name string - map[string]string
- Key-value map of resource tags for the place index.
- Update
Time string - Timestamp for when the place index resource was last updated in ISO 8601 format.
- create
Time String - Timestamp for when the place index resource was created in ISO 8601 format.
- data
Source String - Data provider of geospatial data.
- data
Source List<GetConfigurations Place Index Data Source Configuration> - 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.
- index
Arn String - ARN for the place index resource.
- index
Name String - Map<String,String>
- Key-value map of resource tags for the place index.
- update
Time String - Timestamp for when the place index resource was last updated in ISO 8601 format.
- create
Time string - Timestamp for when the place index resource was created in ISO 8601 format.
- data
Source string - Data provider of geospatial data.
- data
Source GetConfigurations Place Index Data Source Configuration[] - 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.
- index
Arn string - ARN for the place index resource.
- index
Name string - {[key: string]: string}
- Key-value map of resource tags for the place index.
- update
Time 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_ Sequence[Getconfigurations Place Index Data Source Configuration] - 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 - 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.
- create
Time String - Timestamp for when the place index resource was created in ISO 8601 format.
- data
Source String - Data provider of geospatial data.
- data
Source List<Property Map>Configurations - 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.
- index
Arn String - ARN for the place index resource.
- index
Name String - Map<String>
- Key-value map of resource tags for the place index.
- update
Time String - Timestamp for when the place index resource was last updated in ISO 8601 format.
Supporting Types
GetPlaceIndexDataSourceConfiguration
- Intended
Use string
- Intended
Use string
- intended
Use String
- intended
Use string
- intended_
use str
- intended
Use String
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.