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

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::DescribePlaceIndexResponse

Includes:

Structure

Defined in:

lib/aws-sdk-locationservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #create_time ⇒ Time

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

• #data_source ⇒ String

  The data provider of geospatial data.

• #data_source_configuration ⇒ Types::DataSourceConfiguration

  The specified data storage option for requesting Places.

• #description ⇒ String

  The optional description for the place index resource.

• #index_arn ⇒ String

  The Amazon Resource Name (ARN) for the place index resource.

• #index_name ⇒ String

  The name of the place index resource being described.

• #pricing_plan ⇒ String

  No longer used.

• #tags ⇒ Hash<String,String>

  Tags associated with place index resource.

• #update_time ⇒ Time

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

Instance Attribute Details

#create_time ⇒ Time

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

[1]: www.iso.org/iso-8601-date-and-time-format.html

Returns:

• (Time)

# File 'lib/aws-sdk-locationservice/types.rb', line 2576

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

#data_source ⇒ String

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].

[1]: docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html

Returns:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 2576

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

#data_source_configuration ⇒ Types::DataSourceConfiguration

The specified data storage option for requesting Places.

Returns:

• (Types::DataSourceConfiguration)

# File 'lib/aws-sdk-locationservice/types.rb', line 2576

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

#description ⇒ String

The optional description for the place index resource.

Returns:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 2576

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

#index_arn ⇒ String

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)

# File 'lib/aws-sdk-locationservice/types.rb', line 2576

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

#index_name ⇒ String

The name of the place index resource being described.

Returns:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 2576

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

#pricing_plan ⇒ String

No longer used. Always returns ‘RequestBasedUsage`.

Returns:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 2576

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

#tags ⇒ Hash<String,String>

Tags associated with place index resource.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-locationservice/types.rb', line 2576

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

#update_time ⇒ Time

The timestamp for when the place index resource was last updated in

ISO 8601][1

format: ‘YYYY-MM-DDThh:mm:ss.sssZ`.

[1]: www.iso.org/iso-8601-date-and-time-format.html

Returns:

• (Time)

# File 'lib/aws-sdk-locationservice/types.rb', line 2576

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