Specifies the data storage option chosen for requesting Places.

When using Amazon Location Places:

If using HERE Technologies as a data provider, you can't store results for locations in Japan by setting IntendedUse to Storage. parameter.
Under the MobileAssetTracking or MobilAssetManagement pricing plan, you can't store results from your place index resources by setting IntendedUse to Storage. This returns a validation exception error.

For more information, see the AWS Service Terms for Amazon Location Service.

",{"_641":1915},{"_1916":1917},"allOf",[1918,1920],{"_1778":1919},"#/definitions/405525",{"_23":1921},"

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

","x-apidog-orders",[641],"Description",{"_23":1926,"_5":1888,"_1927":185,"_1928":1929},"Updates the description for the place index resource.","minLength","maxLength",1000,{"_23":1931,"_5":1888,"_1932":1933},"

Updates the pricing plan for the place index resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

","enum",[1934,1935,1936],"RequestBasedUsage","MobileAssetTracking","MobileAssetManagement",[1136,1924,1111],"examples",[1940],{"_177":1941,"_1892":1942,"_23":117,"_1782":1906,"_22":1943},"e6dc9822-a2c7-4052-8856-f4aaea3b4467","{\n \"DataSourceConfiguration\": {\n \"IntendedUse\": \"SingleUse\"\n },\n \"Description\": \"string\",\n \"PricingPlan\": \"RequestBasedUsage\"\n}","Example","codeSamples",[],"codeSampleLanguages",[1948,1966,1984,1991,1997,2002,2013,2021,2026,2033,2039,2045,2051,2057,2062],{"_177":1949,"_1950":1951,"_1952":1953,"_1954":1955},"shell","label","Shell","syntaxMode","powershell","variants",[1956,1958,1960,1962,1964],{"_177":1957},"cURL",{"_177":1959},"cURL-Windows",{"_177":1961},"Httpie",{"_177":1963},"wget",{"_177":1965},"PowerShell",{"_177":1967,"_1950":1968,"_1952":1967,"_1954":1969},"javascript","JavaScript",[1970,1972,1974,1976,1978,1980,1982],{"_177":1971},"Fetch",{"_177":1973},"Axios",{"_177":1975},"jQuery",{"_177":1977},"XHR",{"_177":1979},"Native",{"_177":1981},"Request",{"_177":1983},"Unirest",{"_177":1985,"_1950":1986,"_1952":1985,"_1954":1987},"java","Java",[1988,1989],{"_177":1983},{"_177":1990},"OkHttp",{"_177":1992,"_1950":1993,"_1952":1992,"_1954":1994},"swift","Swift",[1995],{"_177":1996},"URLSession",{"_177":1998,"_1950":1999,"_1952":1998,"_1954":2000},"go","Go",[2001],{"_177":1979},{"_177":2003,"_1950":2004,"_1952":2003,"_1954":2005},"php","PHP",[2006,2007,2009,2011],{"_177":1957},{"_177":2008},"HTTP_Request2",{"_177":2010},"pecl_http",{"_177":2012},"Guzzle",{"_177":2014,"_1950":2015,"_1952":2014,"_1954":2016},"python","Python",[2017,2019],{"_177":2018},"http.client",{"_177":2020},"Requests",{"_177":138,"_1950":2022,"_1952":2023,"_1954":2024},"HTTP","text",[2025],{"_177":2022},{"_177":2027,"_1950":2028,"_1952":2029,"_1954":2030},"c","C","cpp",[2031],{"_177":2032},"libcurl",{"_177":2034,"_1950":2035,"_1952":2034,"_1954":2036},"csharp","C#",[2037],{"_177":2038},"RestSharp",{"_177":2040,"_1950":2041,"_1952":2040,"_1954":2042},"objective-c","Objective-C",[2043],{"_177":2044},"NSURLSession",{"_177":2046,"_1950":2047,"_1952":2046,"_1954":2048},"ruby","Ruby",[2049],{"_177":2050},"Net::HTTP",{"_177":2052,"_1950":2053,"_1952":2052,"_1954":2054},"ocaml","OCaml",[2055],{"_177":2056},"Cohttp",{"_177":2058,"_1950":2059,"_1952":2058,"_1954":2060},"dart","Dart",[2061],{"_177":138},{"_177":2063,"_1950":2064,"_1952":2063,"_1954":2065},"r","R",[2066,2068],{"_177":2067},"httr",{"_177":2069},"RCurl","extraData",{"_2072":2073,"_2080":2081,"_2134":2135,"_2162":2163,"_1751":117,"_2168":2169,"_2170":2171,"_1865":117},"apiFieldList",[2074],{"_5":1870,"_177":2075,"_22":2076,"_1892":1869,"_2077":2078,"_2079":51},"updateAt","Last modified:","format","2022-09-10 19:59:22","hidden","dataSchemaDefinitions",{"_2082":2083,"_2084":2085,"_2086":2087,"_2088":2089,"_2090":2091,"_2092":2093,"_2097":2098,"_2122":2123,"_2127":2128,"_2131":2132},"405498",{"_30":536,"_22":536},"405501",{"_30":506,"_22":506},"405503",{"_30":526,"_22":526},"405504",{"_30":511,"_22":511},"405505",{"_30":521,"_22":521},"405525",{"_5":1888,"_1932":2094,"_30":641,"_22":641},[2095,2096],"SingleUse","Storage","405567",{"_5":1909,"_1886":2099,"_1910":2102,"_1922":2121,"_30":841,"_22":841},[2100,1885,2101],"IndexArn","UpdateTime",{"_2100":2103,"_1885":2109,"_2101":2115},{"_1916":2104},[2105,2107],{"_1778":2106},"#/definitions/405570",{"_23":2108},"

The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a resource across AWS.

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

",{"_1916":2110},[2111,2113],{"_1778":2112},"#/definitions/405569",{"_23":2114},"The name of the updated place index resource.",{"_1916":2116},[2117,2119],{"_1778":2118},"#/definitions/405582",{"_23":2120},"The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. ",[2100,1885,2101],"405569",{"_5":1888,"_2124":2125,"_1927":1793,"_1928":2126,"_30":866,"_22":866},"pattern","^[-._\\w]+$",100,"405570",{"_5":1888,"_2124":2129,"_1927":185,"_1928":2130,"_30":856,"_22":856},"^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$",1600,"405582",{"_5":1888,"_2077":2133,"_30":921,"_22":921},"date-time","requestCollection",{"_2136":2137,"_1895":2153,"_179":2156,"_2157":2158,"_1900":2159,"_5":138},"url",{"_2138":138,"_181":2139,"_2143":2144,"_1881":2149,"_2150":2151},"protocol",[2140,2141,2142,117],"places","v0","indexes","host",[2145,2146,2147,2148],"geo","{region}","amazonaws","com",[],"variable",[2152],{"_1746":156,"_5":1888,"_1892":117,"_177":1885},[2154],{"_177":2155,"_1892":1906},"Content-Type","PATCH","baseUrl","http://geo.{region}.amazonaws.com",{"_2160":2161,"_2161":117,"_5":1906},"mode","raw","defaultRequestSampleCode",{"_1772":2164,"_1671":1949,"_2165":1957,"_2166":1953,"_2167":-7},"curl --location -g --request PATCH 'http://geo.{region}.amazonaws.com/places/v0/indexes/' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"DataSourceConfiguration\": {\n \"IntendedUse\": \"SingleUse\"\n },\n \"Description\": \"string\",\n \"PricingPlan\": \"RequestBasedUsage\"\n}'","variant","codeBlockLanguage","prompt","securitySchemeMap",{},"inheritAuthInfo",{"_2172":2173,"_2174":2175,"_1765":2176,"_1876":2177},"definitionInheritFrom",{"_22":117,"_174":185},"valueInheritFrom",{"_22":117,"_174":185},{"_5":-7},{"_2178":-7,"_2179":2180},"use","scopes",{},"docsIdTypeData",{"_2183":2184,"_2185":1853,"_1852":1853,"_2186":2187,"_2188":2189,"_2190":2191,"_2192":117,"_2193":-7},"onlineType","APIDOC","onlineId","teamId",97,"branchId",308980,"visitType","customDomain","subdirectory","specialFileType","notification",[],"footerBanner",[],"projectSetting",{"_1765":2200,"_1859":2201,"_1876":2216,"_2217":2218,"_1752":2219,"_1754":2220},{},{"_2202":156,"_2203":156,"_2204":51,"_2205":2206,"_2207":156,"_2208":156,"_2209":2210},"enableJsonc","enableBigint","responseValidate","isDefaultUrlEncoding",3,"enableTestScenarioSetting","enableYAPICompatScript","publishedDocUrlRules",{"_2211":2212,"_2213":2214,"_2215":51},"defaultRule","RESOURCE_KEY_ONLY","resourceKeyStandard","LEGACY","enableResourceKeyStandard",{},"mockSettings",{},[],[],"environments",{"_2223":2224,"_2250":2251,"_2315":2316},"selectedEnvironment",{"_174":2225,"_22":2226,"_2157":2158,"_2227":2228,"_2229":2230,"_2231":2232,"_2233":2234,"_2235":2236,"_1879":2237,"_2242":2243,"_5":2244,"_1874":2245,"_1852":1853,"_2246":2022,"_1871":1872,"_1792":185,"_187":2247,"_1873":1872,"_1868":2248,"_1870":2248,"_1859":2249},356333,"The Amazon Location Service multi-region endpoint","baseUrls",{"_1725":2158},"websocketBaseUrls",{},"socketioBaseUrls",{},"requestProxyAgentSettings",{},"variables",[],{"_1893":2238,"_1881":2239,"_1895":2240,"_1900":2241},[],[],[],[],"registrationCenters",[],"normal","protected","projectType",[],"2022-09-10T19:59:20.000Z",{},"environmentList",[2252,2266,2283,2299],{"_174":2225,"_22":2226,"_2157":2158,"_2227":2253,"_2229":2254,"_2231":2255,"_2233":2256,"_2235":2257,"_1879":2258,"_2242":2263,"_5":2244,"_1874":2245,"_1852":1853,"_2246":2022,"_1871":1872,"_1792":185,"_187":2264,"_1873":1872,"_1868":2248,"_1870":2248,"_1859":2265},{"_1725":2158},{},{},{},[],{"_1893":2259,"_1881":2260,"_1895":2261,"_1900":2262},[],[],[],[],[],[],{},{"_174":2267,"_22":2268,"_2157":2269,"_2227":2270,"_2229":2271,"_2231":2272,"_2233":2273,"_2235":2274,"_1879":2275,"_2242":2280,"_5":2244,"_1874":2245,"_1852":1853,"_2246":2022,"_1871":1872,"_1792":185,"_187":2281,"_1873":1872,"_1868":2248,"_1870":2248,"_1859":2282},356334,"The Amazon Location Service endpoint for China (Beijing) and China (Ningxia)","http://geo.{region}.amazonaws.com.cn",{"_1725":2269},{},{},{},[],{"_1893":2276,"_1881":2277,"_1895":2278,"_1900":2279},[],[],[],[],[],[],{},{"_174":2284,"_22":2226,"_2157":2285,"_2227":2286,"_2229":2287,"_2231":2288,"_2233":2289,"_2235":2290,"_1879":2291,"_2242":2296,"_5":2244,"_1874":2245,"_1852":1853,"_2246":2022,"_1871":1872,"_1792":185,"_187":2297,"_1873":1872,"_1868":2248,"_1870":2248,"_1859":2298},356335,"https://geo.{region}.amazonaws.com",{"_1725":2285},{},{},{},[],{"_1893":2292,"_1881":2293,"_1895":2294,"_1900":2295},[],[],[],[],[],[],{},{"_174":2300,"_22":2268,"_2157":2301,"_2227":2302,"_2229":2303,"_2231":2304,"_2233":2305,"_2235":2306,"_1879":2307,"_2242":2312,"_5":2244,"_1874":2245,"_1852":1853,"_2246":2022,"_1871":1872,"_1792":185,"_187":2313,"_1873":1872,"_1868":2248,"_1870":2248,"_1859":2314},356336,"https://geo.{region}.amazonaws.com.cn",{"_1725":2301},{},{},{},[],{"_1893":2308,"_1881":2309,"_1895":2310,"_1900":2311},[],[],[],[],[],[],{},"servers",[2317],{"_174":1725,"_22":2318},"Default Server","searchSettings",{},"versionSettings",[2323],{"_2188":2189,"_2324":51,"_22":1745,"_2325":1745,"_2221":2326},"isDefaultVersion","slug",{"_2327":2328,"_2329":2225},"environmentIds",[2225,2267,2284,2300],"defaultEnvironmentId","seoInfos",["M"],"itemPathPrefix",{"_2157":117,"_2334":117,"_2192":117,"_2335":156},"versionSlug","isSharedDocIndependentDomain","appEnvMap",{"_2338":129},"appBrowserExtensionAdapterKey","customCodes",{"_1967":117},"primaryColorVariable",{"_1650":2343,"_1654":2344},"--ui-primary-color-hover: var(--ui-primary-5);--ui-primary-color-active: var(--ui-primary-7);--ui-picker-basic-cell-hover-with-range-color: #36139c;--ui-picker-date-hover-range-border-color: #4e1be0;--ui-primary-base: #9373EE;--ui-primary-base-p: 147, 115, 238;--ui-primary-color-p: 147, 115, 238;--ui-primary-color: #9373EE;--ui-primary-10: #362b50;--ui-primary-9: #51407e;--ui-primary-8: #634e9b;--ui-primary-7: #7a60c4;--ui-primary-7-p: 122, 96, 196;--ui-primary-6: #9373EE;--ui-primary-6-p: 147, 115, 238;--ui-primary-5: #b499f4;--ui-primary-5-p: 180, 153, 244;--ui-primary-4: #cebaf8;--ui-primary-3: #dfd1fb;--ui-primary-2: #ebe2fc;--ui-primary-1: #f3eefe;--ui-primary-1-p: 243, 238, 254;--ui-primary-a: #f7f3fe;--ui-primary-b: #fbf9ff;--g-color-primary: #9373EE;--ui-btn-primary-color: #fff;--ui-lime-6-p: 160,217,17;--ui-orange-6-p: 250,140,22;--ui-yellow-6-p: 250,219,20;--ui-pink-6-p: 235,47,150;--ui-body-background: #ffffff;--theme-tars-item-active-bg: var(--ui-tree-node-selected-bg);--ifm-menu-color: var(--ui-text-color-sub);--ifm-menu-color-active: var(--ui-text-color-sub);--ifm-menu-color-background-hover: var(--ui-item-hover-bg);--theme-tars-border-color-split: var(--ui-border-color-split);","--ui-primary-color-hover: var(--ui-primary-7);--ui-primary-color-active: var(--ui-primary-5);--ui-picker-basic-cell-hover-with-range-color: #312865;--ui-picker-date-hover-range-border-color: #4b3d9c;--ui-primary-base: #8276C9;--ui-primary-base-p: 130, 118, 201;--ui-primary-color-p: 130, 118, 201;--ui-primary-color: #8276C9;--ui-primary-10: #dcd7f0;--ui-primary-9: #a69bd9;--ui-primary-8: #b0a5dd;--ui-primary-7: #9c90d4;--ui-primary-7-p: 156, 144, 212;--ui-primary-6: #8276C9;--ui-primary-6-p: 130, 118, 201;--ui-primary-5: #635a96;--ui-primary-5-p: 99, 90, 150;--ui-primary-4: #49436c;--ui-primary-3: #393452;--ui-primary-2: #312d46;--ui-primary-1: #252333;--ui-primary-1-p: 37, 35, 51;--ui-primary-a: #21202d;--ui-primary-b: #1e1c28;--g-color-primary: #8276C9;--ui-btn-primary-color: #fff;--ui-lime-6-p: 160,217,17;--ui-orange-6-p: 250,140,22;--ui-yellow-6-p: 250,219,20;--ui-pink-6-p: 235,47,150;--ui-body-background: #1a1922;--theme-tars-item-active-bg: var(--ui-tree-node-selected-bg);--ifm-menu-color: var(--ui-text-color-sub);--ifm-menu-color-active: var(--ui-text-color-sub);--ifm-menu-color-background-hover: var(--ui-item-hover-bg);--theme-tars-border-color-split: var(--ui-border-color-split);","routes/_index/route","actionData","errors"]

/places/v0/indexes/{IndexName}

Request

Responses