/aws/regions

POST /api/aws/regions

Price: 1 credit

List the AWS locations that EC2 prices are published for. Each entry carries the region code used everywhere else on this platform, the display name the pricing files are keyed by, the continent, and whether it is a standard region, a Local Zone or a Wavelength Zone. Narrows by kind and by continent.

How to use it

Call this first when you have a place name rather than a region code: `id` is the code the other aws endpoints accept, and `name` is the display form AWS keys its price files by. `location_type` separates standard regions from Local Zones and Wavelength Zones, which are edge sites rather than full regions.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location_type string nullable — Keep only entries of this kind. Unset returns standard regions, Local Zones and Wavelength Zones together (one of: "AWS Region", "AWS Local Zone", "AWS Wavelength Zone")
• continent string nullable — Keep only entries on this continent, matched case-insensitively (examples: "Europe", "North America"; minLength: 1)
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "AwsRegion")
• id string required
• name string nullable
• label string nullable
• location_type string nullable
• continent string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No location matched the requested kind and continent. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.