PUT
/
basins
/
{basin}
curl --request PUT \
  --url https://aws.s2.dev/v1alpha/basins/{basin} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "assignment": null,
  "config": null
}'
{
  "cell": "<string>",
  "name": "<string>",
  "scope": "<string>",
  "state": "unspecified"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
s2-request-token
string

Path Parameters

​
basin
string
required

Name of the basin.

Body

application/json

Create basin request.

​
assignment
object | null

Assignment of the basin to a cloud and region, or an explicit cell.

​
config
object | null

Basin configuration.

Response

201
application/json

Basin information.

​
cell
string
required

Cell assignment.

​
name
string
required

Basin name.

​
scope
string
required

Basin scope.

​
state
enum<string>
required

Basin state.

Available options:
unspecified,
active,
creating,
deleting
Get basin configuration.Delete a basin.