Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. location
  5. getPlaceIndex

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.location.getPlaceIndex

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Location::PlaceIndex Resource Type

    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,
                    opts: Optional[InvokeOptions] = None) -> GetPlaceIndexResult
def get_place_index_output(index_name: Optional[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-native:location:getPlaceIndex
  arguments:
    # arguments dictionary

    The following arguments are supported:

    IndexName string

    The name of the place index resource.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique place index resource name.
    • No spaces allowed. For example, ExamplePlaceIndex .
    IndexName string

    The name of the place index resource.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique place index resource name.
    • No spaces allowed. For example, ExamplePlaceIndex .
    indexName String

    The name of the place index resource.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique place index resource name.
    • No spaces allowed. For example, ExamplePlaceIndex .
    indexName string

    The name of the place index resource.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique place index resource name.
    • No spaces allowed. For example, ExamplePlaceIndex .
    index_name str

    The name of the place index resource.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique place index resource name.
    • No spaces allowed. For example, ExamplePlaceIndex .
    indexName String

    The name of the place index resource.

    Requirements:

    • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
    • Must be a unique place index resource name.
    • No spaces allowed. For example, ExamplePlaceIndex .

    getPlaceIndex Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

    • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
    CreateTime string
    The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    DataSourceConfiguration Pulumi.AwsNative.Location.Outputs.PlaceIndexDataSourceConfiguration
    Specifies the data storage option requesting Places.
    Description string
    The optional description for the place index resource.
    IndexArn string
    Synonym for Arn . The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

    • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
    PricingPlan Pulumi.AwsNative.Location.PlaceIndexPricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    UpdateTime string
    The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    Arn string
    The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

    • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
    CreateTime string
    The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    DataSourceConfiguration PlaceIndexDataSourceConfiguration
    Specifies the data storage option requesting Places.
    Description string
    The optional description for the place index resource.
    IndexArn string
    Synonym for Arn . The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

    • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
    PricingPlan PlaceIndexPricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    Tags Tag
    An array of key-value pairs to apply to this resource.
    UpdateTime string
    The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn String
    The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

    • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
    createTime String
    The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    dataSourceConfiguration PlaceIndexDataSourceConfiguration
    Specifies the data storage option requesting Places.
    description String
    The optional description for the place index resource.
    indexArn String
    Synonym for Arn . The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

    • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
    pricingPlan PlaceIndexPricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    updateTime String
    The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn string
    The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

    • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
    createTime string
    The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    dataSourceConfiguration PlaceIndexDataSourceConfiguration
    Specifies the data storage option requesting Places.
    description string
    The optional description for the place index resource.
    indexArn string
    Synonym for Arn . The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

    • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
    pricingPlan PlaceIndexPricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    tags Tag[]
    An array of key-value pairs to apply to this resource.
    updateTime string
    The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn str
    The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

    • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
    create_time str
    The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    data_source_configuration PlaceIndexDataSourceConfiguration
    Specifies the data storage option requesting Places.
    description str
    The optional description for the place index resource.
    index_arn str
    Synonym for Arn . The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

    • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
    pricing_plan PlaceIndexPricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    update_time str
    The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn String
    The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

    • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
    createTime String
    The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    dataSourceConfiguration Property Map
    Specifies the data storage option requesting Places.
    description String
    The optional description for the place index resource.
    indexArn String
    Synonym for Arn . The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

    • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
    pricingPlan "RequestBasedUsage"

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    updateTime String
    The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    Supporting Types

    PlaceIndexDataSourceConfiguration

    IntendedUse Pulumi.AwsNative.Location.PlaceIndexIntendedUse

    Specifies how the results of an operation will be stored by the caller.

    Valid values include:

    • SingleUse specifies that the results won't be stored.
    • Storage specifies that the result can be cached or stored in a database.

    Default value: SingleUse

    IntendedUse PlaceIndexIntendedUse

    Specifies how the results of an operation will be stored by the caller.

    Valid values include:

    • SingleUse specifies that the results won't be stored.
    • Storage specifies that the result can be cached or stored in a database.

    Default value: SingleUse

    intendedUse PlaceIndexIntendedUse

    Specifies how the results of an operation will be stored by the caller.

    Valid values include:

    • SingleUse specifies that the results won't be stored.
    • Storage specifies that the result can be cached or stored in a database.

    Default value: SingleUse

    intendedUse PlaceIndexIntendedUse

    Specifies how the results of an operation will be stored by the caller.

    Valid values include:

    • SingleUse specifies that the results won't be stored.
    • Storage specifies that the result can be cached or stored in a database.

    Default value: SingleUse

    intended_use PlaceIndexIntendedUse

    Specifies how the results of an operation will be stored by the caller.

    Valid values include:

    • SingleUse specifies that the results won't be stored.
    • Storage specifies that the result can be cached or stored in a database.

    Default value: SingleUse

    intendedUse "SingleUse" | "Storage"

    Specifies how the results of an operation will be stored by the caller.

    Valid values include:

    • SingleUse specifies that the results won't be stored.
    • Storage specifies that the result can be cached or stored in a database.

    Default value: SingleUse

    PlaceIndexIntendedUse

    PlaceIndexPricingPlan

    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.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native