AWS SDK for C++  1.9.44
AWS SDK for C++
Public Member Functions | List of all members
Aws::LocationService::Model::CreatePlaceIndexRequest Class Reference

#include <CreatePlaceIndexRequest.h>

+ Inheritance diagram for Aws::LocationService::Model::CreatePlaceIndexRequest:

Public Member Functions

 CreatePlaceIndexRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDataSource () const
 
bool DataSourceHasBeenSet () const
 
void SetDataSource (const Aws::String &value)
 
void SetDataSource (Aws::String &&value)
 
void SetDataSource (const char *value)
 
CreatePlaceIndexRequestWithDataSource (const Aws::String &value)
 
CreatePlaceIndexRequestWithDataSource (Aws::String &&value)
 
CreatePlaceIndexRequestWithDataSource (const char *value)
 
const DataSourceConfigurationGetDataSourceConfiguration () const
 
bool DataSourceConfigurationHasBeenSet () const
 
void SetDataSourceConfiguration (const DataSourceConfiguration &value)
 
void SetDataSourceConfiguration (DataSourceConfiguration &&value)
 
CreatePlaceIndexRequestWithDataSourceConfiguration (const DataSourceConfiguration &value)
 
CreatePlaceIndexRequestWithDataSourceConfiguration (DataSourceConfiguration &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreatePlaceIndexRequestWithDescription (const Aws::String &value)
 
CreatePlaceIndexRequestWithDescription (Aws::String &&value)
 
CreatePlaceIndexRequestWithDescription (const char *value)
 
const Aws::StringGetIndexName () const
 
bool IndexNameHasBeenSet () const
 
void SetIndexName (const Aws::String &value)
 
void SetIndexName (Aws::String &&value)
 
void SetIndexName (const char *value)
 
CreatePlaceIndexRequestWithIndexName (const Aws::String &value)
 
CreatePlaceIndexRequestWithIndexName (Aws::String &&value)
 
CreatePlaceIndexRequestWithIndexName (const char *value)
 
const PricingPlanGetPricingPlan () const
 
bool PricingPlanHasBeenSet () const
 
void SetPricingPlan (const PricingPlan &value)
 
void SetPricingPlan (PricingPlan &&value)
 
CreatePlaceIndexRequestWithPricingPlan (const PricingPlan &value)
 
CreatePlaceIndexRequestWithPricingPlan (PricingPlan &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreatePlaceIndexRequestWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
CreatePlaceIndexRequestWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreatePlaceIndexRequestAddTags (const Aws::String &key, const Aws::String &value)
 
CreatePlaceIndexRequestAddTags (Aws::String &&key, const Aws::String &value)
 
CreatePlaceIndexRequestAddTags (const Aws::String &key, Aws::String &&value)
 
CreatePlaceIndexRequestAddTags (Aws::String &&key, Aws::String &&value)
 
CreatePlaceIndexRequestAddTags (const char *key, Aws::String &&value)
 
CreatePlaceIndexRequestAddTags (Aws::String &&key, const char *value)
 
CreatePlaceIndexRequestAddTags (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::LocationService::LocationServiceRequest
virtual ~LocationServiceRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::LocationService::LocationServiceRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file CreatePlaceIndexRequest.h.

Constructor & Destructor Documentation

◆ CreatePlaceIndexRequest()

Aws::LocationService::Model::CreatePlaceIndexRequest::CreatePlaceIndexRequest ( )

Member Function Documentation

◆ AddTags() [1/7]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / .

Definition at line 487 of file CreatePlaceIndexRequest.h.

◆ AddTags() [2/7]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / .

Definition at line 463 of file CreatePlaceIndexRequest.h.

◆ AddTags() [3/7]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / .

Definition at line 511 of file CreatePlaceIndexRequest.h.

◆ AddTags() [4/7]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / .

Definition at line 475 of file CreatePlaceIndexRequest.h.

◆ AddTags() [5/7]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / .

Definition at line 451 of file CreatePlaceIndexRequest.h.

◆ AddTags() [6/7]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / .

Definition at line 499 of file CreatePlaceIndexRequest.h.

◆ AddTags() [7/7]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::AddTags ( const char *  key,
const char *  value 
)
inline

Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / .

Definition at line 523 of file CreatePlaceIndexRequest.h.

◆ DataSourceConfigurationHasBeenSet()

bool Aws::LocationService::Model::CreatePlaceIndexRequest::DataSourceConfigurationHasBeenSet ( ) const
inline

Specifies the data storage option for requesting Places.

Definition at line 183 of file CreatePlaceIndexRequest.h.

◆ DataSourceHasBeenSet()

bool Aws::LocationService::Model::CreatePlaceIndexRequest::DataSourceHasBeenSet ( ) const
inline

Specifies the data provider of geospatial data.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE will return an error.

Valid values include:

  • Esri

  • Here

    Place index resources using HERE as a data provider can't be used to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional details on data providers, see the Amazon Location Service data providers page.

Definition at line 70 of file CreatePlaceIndexRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::LocationService::Model::CreatePlaceIndexRequest::DescriptionHasBeenSet ( ) const
inline

The optional description for the place index resource.

Definition at line 214 of file CreatePlaceIndexRequest.h.

◆ GetDataSource()

const Aws::String& Aws::LocationService::Model::CreatePlaceIndexRequest::GetDataSource ( ) const
inline

Specifies the data provider of geospatial data.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE will return an error.

Valid values include:

  • Esri

  • Here

    Place index resources using HERE as a data provider can't be used to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional details on data providers, see the Amazon Location Service data providers page.

Definition at line 53 of file CreatePlaceIndexRequest.h.

◆ GetDataSourceConfiguration()

const DataSourceConfiguration& Aws::LocationService::Model::CreatePlaceIndexRequest::GetDataSourceConfiguration ( ) const
inline

Specifies the data storage option for requesting Places.

Definition at line 178 of file CreatePlaceIndexRequest.h.

◆ GetDescription()

const Aws::String& Aws::LocationService::Model::CreatePlaceIndexRequest::GetDescription ( ) const
inline

The optional description for the place index resource.

Definition at line 209 of file CreatePlaceIndexRequest.h.

◆ GetIndexName()

const Aws::String& Aws::LocationService::Model::CreatePlaceIndexRequest::GetIndexName ( ) const
inline

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.

Definition at line 254 of file CreatePlaceIndexRequest.h.

◆ GetPricingPlan()

const PricingPlan& Aws::LocationService::Model::CreatePlaceIndexRequest::GetPricingPlan ( ) const
inline

Specifies the pricing plan for your place index resource.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

Definition at line 326 of file CreatePlaceIndexRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::LocationService::Model::CreatePlaceIndexRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file CreatePlaceIndexRequest.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::LocationService::Model::CreatePlaceIndexRequest::GetTags ( ) const
inline

Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / .

Definition at line 379 of file CreatePlaceIndexRequest.h.

◆ IndexNameHasBeenSet()

bool Aws::LocationService::Model::CreatePlaceIndexRequest::IndexNameHasBeenSet ( ) const
inline

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.

Definition at line 263 of file CreatePlaceIndexRequest.h.

◆ PricingPlanHasBeenSet()

bool Aws::LocationService::Model::CreatePlaceIndexRequest::PricingPlanHasBeenSet ( ) const
inline

Specifies the pricing plan for your place index resource.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

Definition at line 334 of file CreatePlaceIndexRequest.h.

◆ SerializePayload()

Aws::String Aws::LocationService::Model::CreatePlaceIndexRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDataSource() [1/3]

void Aws::LocationService::Model::CreatePlaceIndexRequest::SetDataSource ( Aws::String &&  value)
inline

Specifies the data provider of geospatial data.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE will return an error.

Valid values include:

  • Esri

  • Here

    Place index resources using HERE as a data provider can't be used to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional details on data providers, see the Amazon Location Service data providers page.

Definition at line 104 of file CreatePlaceIndexRequest.h.

◆ SetDataSource() [2/3]

void Aws::LocationService::Model::CreatePlaceIndexRequest::SetDataSource ( const Aws::String value)
inline

Specifies the data provider of geospatial data.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE will return an error.

Valid values include:

  • Esri

  • Here

    Place index resources using HERE as a data provider can't be used to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional details on data providers, see the Amazon Location Service data providers page.

Definition at line 87 of file CreatePlaceIndexRequest.h.

◆ SetDataSource() [3/3]

void Aws::LocationService::Model::CreatePlaceIndexRequest::SetDataSource ( const char *  value)
inline

Specifies the data provider of geospatial data.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE will return an error.

Valid values include:

  • Esri

  • Here

    Place index resources using HERE as a data provider can't be used to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional details on data providers, see the Amazon Location Service data providers page.

Definition at line 121 of file CreatePlaceIndexRequest.h.

◆ SetDataSourceConfiguration() [1/2]

void Aws::LocationService::Model::CreatePlaceIndexRequest::SetDataSourceConfiguration ( const DataSourceConfiguration value)
inline

Specifies the data storage option for requesting Places.

Definition at line 188 of file CreatePlaceIndexRequest.h.

◆ SetDataSourceConfiguration() [2/2]

void Aws::LocationService::Model::CreatePlaceIndexRequest::SetDataSourceConfiguration ( DataSourceConfiguration &&  value)
inline

Specifies the data storage option for requesting Places.

Definition at line 193 of file CreatePlaceIndexRequest.h.

◆ SetDescription() [1/3]

void Aws::LocationService::Model::CreatePlaceIndexRequest::SetDescription ( Aws::String &&  value)
inline

The optional description for the place index resource.

Definition at line 224 of file CreatePlaceIndexRequest.h.

◆ SetDescription() [2/3]

void Aws::LocationService::Model::CreatePlaceIndexRequest::SetDescription ( const Aws::String value)
inline

The optional description for the place index resource.

Definition at line 219 of file CreatePlaceIndexRequest.h.

◆ SetDescription() [3/3]

void Aws::LocationService::Model::CreatePlaceIndexRequest::SetDescription ( const char *  value)
inline

The optional description for the place index resource.

Definition at line 229 of file CreatePlaceIndexRequest.h.

◆ SetIndexName() [1/3]

void Aws::LocationService::Model::CreatePlaceIndexRequest::SetIndexName ( Aws::String &&  value)
inline

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.

Definition at line 281 of file CreatePlaceIndexRequest.h.

◆ SetIndexName() [2/3]

void Aws::LocationService::Model::CreatePlaceIndexRequest::SetIndexName ( const Aws::String value)
inline

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.

Definition at line 272 of file CreatePlaceIndexRequest.h.

◆ SetIndexName() [3/3]

void Aws::LocationService::Model::CreatePlaceIndexRequest::SetIndexName ( const char *  value)
inline

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.

Definition at line 290 of file CreatePlaceIndexRequest.h.

◆ SetPricingPlan() [1/2]

void Aws::LocationService::Model::CreatePlaceIndexRequest::SetPricingPlan ( const PricingPlan value)
inline

Specifies the pricing plan for your place index resource.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

Definition at line 342 of file CreatePlaceIndexRequest.h.

◆ SetPricingPlan() [2/2]

void Aws::LocationService::Model::CreatePlaceIndexRequest::SetPricingPlan ( PricingPlan &&  value)
inline

Specifies the pricing plan for your place index resource.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

Definition at line 350 of file CreatePlaceIndexRequest.h.

◆ SetTags() [1/2]

void Aws::LocationService::Model::CreatePlaceIndexRequest::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / .

Definition at line 415 of file CreatePlaceIndexRequest.h.

◆ SetTags() [2/2]

void Aws::LocationService::Model::CreatePlaceIndexRequest::SetTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / .

Definition at line 403 of file CreatePlaceIndexRequest.h.

◆ TagsHasBeenSet()

bool Aws::LocationService::Model::CreatePlaceIndexRequest::TagsHasBeenSet ( ) const
inline

Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / .

Definition at line 391 of file CreatePlaceIndexRequest.h.

◆ WithDataSource() [1/3]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::WithDataSource ( Aws::String &&  value)
inline

Specifies the data provider of geospatial data.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE will return an error.

Valid values include:

  • Esri

  • Here

    Place index resources using HERE as a data provider can't be used to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional details on data providers, see the Amazon Location Service data providers page.

Definition at line 155 of file CreatePlaceIndexRequest.h.

◆ WithDataSource() [2/3]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::WithDataSource ( const Aws::String value)
inline

Specifies the data provider of geospatial data.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE will return an error.

Valid values include:

  • Esri

  • Here

    Place index resources using HERE as a data provider can't be used to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional details on data providers, see the Amazon Location Service data providers page.

Definition at line 138 of file CreatePlaceIndexRequest.h.

◆ WithDataSource() [3/3]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::WithDataSource ( const char *  value)
inline

Specifies the data provider of geospatial data.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE will return an error.

Valid values include:

  • Esri

  • Here

    Place index resources using HERE as a data provider can't be used to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional details on data providers, see the Amazon Location Service data providers page.

Definition at line 172 of file CreatePlaceIndexRequest.h.

◆ WithDataSourceConfiguration() [1/2]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::WithDataSourceConfiguration ( const DataSourceConfiguration value)
inline

Specifies the data storage option for requesting Places.

Definition at line 198 of file CreatePlaceIndexRequest.h.

◆ WithDataSourceConfiguration() [2/2]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::WithDataSourceConfiguration ( DataSourceConfiguration &&  value)
inline

Specifies the data storage option for requesting Places.

Definition at line 203 of file CreatePlaceIndexRequest.h.

◆ WithDescription() [1/3]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::WithDescription ( Aws::String &&  value)
inline

The optional description for the place index resource.

Definition at line 239 of file CreatePlaceIndexRequest.h.

◆ WithDescription() [2/3]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::WithDescription ( const Aws::String value)
inline

The optional description for the place index resource.

Definition at line 234 of file CreatePlaceIndexRequest.h.

◆ WithDescription() [3/3]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::WithDescription ( const char *  value)
inline

The optional description for the place index resource.

Definition at line 244 of file CreatePlaceIndexRequest.h.

◆ WithIndexName() [1/3]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::WithIndexName ( Aws::String &&  value)
inline

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.

Definition at line 308 of file CreatePlaceIndexRequest.h.

◆ WithIndexName() [2/3]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::WithIndexName ( const Aws::String value)
inline

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.

Definition at line 299 of file CreatePlaceIndexRequest.h.

◆ WithIndexName() [3/3]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::WithIndexName ( const char *  value)
inline

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.

Definition at line 317 of file CreatePlaceIndexRequest.h.

◆ WithPricingPlan() [1/2]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::WithPricingPlan ( const PricingPlan value)
inline

Specifies the pricing plan for your place index resource.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

Definition at line 358 of file CreatePlaceIndexRequest.h.

◆ WithPricingPlan() [2/2]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::WithPricingPlan ( PricingPlan &&  value)
inline

Specifies the pricing plan for your place index resource.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

Definition at line 366 of file CreatePlaceIndexRequest.h.

◆ WithTags() [1/2]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / .

Definition at line 439 of file CreatePlaceIndexRequest.h.

◆ WithTags() [2/2]

CreatePlaceIndexRequest& Aws::LocationService::Model::CreatePlaceIndexRequest::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / .

Definition at line 427 of file CreatePlaceIndexRequest.h.


The documentation for this class was generated from the following file: