API docs by Redocly

S3 Governance API documentation (1)

Download OpenAPI specification:

URL: https://docs.starburst.io/support.html License: Copyright Starburst Data

Documentation with details about endpoints and entities.

OpenApi

Return the OpenAPI specification for the S3 Governance API. Use Accept header of 'application/yaml' to request a YAML response instead of JSON.

Authorizations:
01_Cf_Access_OAuth202_Cf_Access_Basic

Responses

Credentials

List credentials for S3 governance

Authorizations:
01_Cf_Access_OAuth202_Cf_Access_Basic
query Parameters
pageToken
string

Page token

pageSize
string [ 1 .. 512 ]
Default: "100"

Page size

pageSort
string
Default: "desc"
Enum: "asc" "desc"

Sorting order

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "count": 0,
  • "result": [
    ]
}

Create credentials for S3 governance

Authorizations:
01_Cf_Access_OAuth202_Cf_Access_Basic
Request Body schema: application/json
user
string
selectedRole
string
objectStoreId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "user": "string",
  • "selectedRole": "string",
  • "objectStoreId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "accessKey": "string",
  • "secretKey": "string",
  • "user": "string",
  • "selectedRole": "string",
  • "objectStoreId": 0
}

Get credentials for S3 governance

Authorizations:
01_Cf_Access_OAuth202_Cf_Access_Basic
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "accessKey": "string",
  • "secretKey": "string",
  • "user": "string",
  • "selectedRole": "string",
  • "objectStoreId": 0
}

Delete credentials for S3 governance

Authorizations:
01_Cf_Access_OAuth202_Cf_Access_Basic
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT",
  • "message": "string",
  • "detailsType": "string",
  • "details": {
    }
}

ObjectStores

List object stores for S3 governance

Authorizations:
01_Cf_Access_OAuth202_Cf_Access_Basic
query Parameters
pageToken
string

Page token

pageSize
string [ 1 .. 512 ]
Default: "100"

Page size

pageSort
string
Default: "desc"
Enum: "asc" "desc"

Sorting order

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "count": 0,
  • "result": [
    ]
}

Create an object store for S3 governance

Authorizations:
01_Cf_Access_OAuth202_Cf_Access_Basic
Request Body schema: application/json
name
string

Name of the object store

provider
string
Enum: "AWS" "CUSTOM"

Specify if this object store is provided by AWS or other S3-compatible object storage service provider

endpoint
string

Customize the endpoint used for establishing connections to the object storage service

accessKeyId
string

Access key ID of the credentials to use for authenticating with the object storage service

secretAccessKey
string

Secret access key to use for authenticating with the object storage service

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "provider": "AWS",
  • "endpoint": "string",
  • "accessKeyId": "string",
  • "secretAccessKey": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "provider": "AWS",
  • "endpoint": "string",
  • "accessKeyId": "string",
  • "isDefault": true
}

Get an object store for S3 governance

Authorizations:
01_Cf_Access_OAuth202_Cf_Access_Basic
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "provider": "AWS",
  • "endpoint": "string",
  • "accessKeyId": "string",
  • "isDefault": true
}

Delete an object store for S3 governance

Authorizations:
01_Cf_Access_OAuth202_Cf_Access_Basic
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT",
  • "message": "string",
  • "detailsType": "string",
  • "details": {
    }
}

Update an object store for S3 governance

Partially update an existing object store. Only the fields provided in the request payload will be updated.

Authorizations:
01_Cf_Access_OAuth202_Cf_Access_Basic
path Parameters
id
required
integer <int64>
Request Body schema: application/json
name
string

Name of the object store

provider
string
Enum: "AWS" "CUSTOM"

Specify if this object store is provided by AWS or other S3-compatible object storage service provider

endpoint
string

Customize the endpoint used for establishing connections to the object storage service

accessKeyId
string

Access key ID of the credentials to use for authenticating with the object storage service

secretAccessKey
string

Secret access key to use for authenticating with the object storage service

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "provider": "AWS",
  • "endpoint": "string",
  • "accessKeyId": "string",
  • "secretAccessKey": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "provider": "AWS",
  • "endpoint": "string",
  • "accessKeyId": "string",
  • "isDefault": true
}

Remove the default object store for S3 governance

Authorizations:
01_Cf_Access_OAuth202_Cf_Access_Basic

Responses

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT",
  • "message": "string",
  • "detailsType": "string",
  • "details": {
    }
}

Set the default object store for S3 governance

When an object store is set as the default, it will be used for S3 governance operations unless another object store is explicitly specified through credentials

Authorizations:
01_Cf_Access_OAuth202_Cf_Access_Basic
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "provider": "AWS",
  • "endpoint": "string",
  • "accessKeyId": "string",
  • "isDefault": true
}