Class: Aws::LocationService::Types::DescribePlaceIndexResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[:create_time, :update_time]

Instance Attribute Summary collapse

Instance Attribute Details

#create_timeTime

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Returns:

  • (Time)


2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2619

class DescribePlaceIndexResponse < Struct.new(
  :index_name,
  :index_arn,
  :pricing_plan,
  :description,
  :create_time,
  :update_time,
  :data_source,
  :data_source_configuration,
  :tags)
  SENSITIVE = [:create_time, :update_time]
  include Aws::Structure
end

#data_sourceString

The data provider of geospatial data. Values can be one of the following:

  • Esri

  • Grab

  • Here

For more information about data providers, see Amazon Location Service data providers.

Returns:

  • (String)


2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2619

class DescribePlaceIndexResponse < Struct.new(
  :index_name,
  :index_arn,
  :pricing_plan,
  :description,
  :create_time,
  :update_time,
  :data_source,
  :data_source_configuration,
  :tags)
  SENSITIVE = [:create_time, :update_time]
  include Aws::Structure
end

#data_source_configurationTypes::DataSourceConfiguration

The specified data storage option for requesting Places.



2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2619

class DescribePlaceIndexResponse < Struct.new(
  :index_name,
  :index_arn,
  :pricing_plan,
  :description,
  :create_time,
  :update_time,
  :data_source,
  :data_source_configuration,
  :tags)
  SENSITIVE = [:create_time, :update_time]
  include Aws::Structure
end

#descriptionString

The optional description for the place index resource.

Returns:

  • (String)


2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2619

class DescribePlaceIndexResponse < Struct.new(
  :index_name,
  :index_arn,
  :pricing_plan,
  :description,
  :create_time,
  :update_time,
  :data_source,
  :data_source_configuration,
  :tags)
  SENSITIVE = [:create_time, :update_time]
  include Aws::Structure
end

#index_arnString

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services.

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

^

Returns:

  • (String)


2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2619

class DescribePlaceIndexResponse < Struct.new(
  :index_name,
  :index_arn,
  :pricing_plan,
  :description,
  :create_time,
  :update_time,
  :data_source,
  :data_source_configuration,
  :tags)
  SENSITIVE = [:create_time, :update_time]
  include Aws::Structure
end

#index_nameString

The name of the place index resource being described.

Returns:

  • (String)


2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2619

class DescribePlaceIndexResponse < Struct.new(
  :index_name,
  :index_arn,
  :pricing_plan,
  :description,
  :create_time,
  :update_time,
  :data_source,
  :data_source_configuration,
  :tags)
  SENSITIVE = [:create_time, :update_time]
  include Aws::Structure
end

#pricing_planString

No longer used. Always returns RequestBasedUsage.

Returns:

  • (String)


2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2619

class DescribePlaceIndexResponse < Struct.new(
  :index_name,
  :index_arn,
  :pricing_plan,
  :description,
  :create_time,
  :update_time,
  :data_source,
  :data_source_configuration,
  :tags)
  SENSITIVE = [:create_time, :update_time]
  include Aws::Structure
end

#tagsHash<String,String>

Tags associated with place index resource.

Returns:

  • (Hash<String,String>)


2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2619

class DescribePlaceIndexResponse < Struct.new(
  :index_name,
  :index_arn,
  :pricing_plan,
  :description,
  :create_time,
  :update_time,
  :data_source,
  :data_source_configuration,
  :tags)
  SENSITIVE = [:create_time, :update_time]
  include Aws::Structure
end

#update_timeTime

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Returns:

  • (Time)


2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2619

class DescribePlaceIndexResponse < Struct.new(
  :index_name,
  :index_arn,
  :pricing_plan,
  :description,
  :create_time,
  :update_time,
  :data_source,
  :data_source_configuration,
  :tags)
  SENSITIVE = [:create_time, :update_time]
  include Aws::Structure
end