Skip to main content
PUT
/
basins
/
{basin}
Create or reconfigure a basin.
curl --request PUT \
  --url https://aws.s2.dev/v1/basins/{basin} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data null
{
  "name": "<string>",
  "scope": "aws:us-east-1",
  "state": "active"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
s2-request-token
string

Client-specified request token for idempotent retries.

Path Parameters

​
basin
string
required

Basin name.

Required string length: 1 - 48

Body

application/json
​
config
object | null

Basin configuration.

​
scope
enum<string>
default:aws:us-east-1

Basin scope. This cannot be reconfigured.

Available options:
aws:us-east-1

Response

​
name
string
required

Basin name.

Required string length: 1 - 48
​
scope
enum<string>
required

Basin scope.

Available options:
aws:us-east-1
​
state
enum<string>
required

Basin state.

Available options:
active,
creating,
deleting