List AWS Regions

Returns a list of valid regions for creating AWS connections

Query Parameters

limit int64
Limits the size of the response on each page to the specified number of items.
start string
Sets the page token used to browse the collection. Leave this parameter empty to get the first page. Other pages can be traversed using HATEOAS links.

Responses

200
default

Success

application/api.clumio.aws-regions=v1+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
items object[]
A collection of requested items.
id string
The ID of the aws region.
is_data_plane_region boolean
Boolean that notes which regions can be designated as targets
name string
Name is a user friendly name of the AWS region.
_links object
URLs to pages related to the resource.
_first object
The HATEOAS link to the first page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_next object
The HATEOAS link to the next page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
current_count int64
The number of items listed on the current page.
limit int64
The maximum number of items displayed per page in the response.
start string
The page token used to get this response.

{
  "_embedded": {
    "items": [
      {
        "id": "string",
        "is_data_plane_region": true,
        "name": "string"
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "limit": 0,
  "start": "string"
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

List AWS Regions​

List AWS Regions