All Products
Search
Document Center

Data Lake Formation:ListProvidedShares

Last Updated:Dec 16, 2025

Retrieves shares.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /dlf/v1/share/shares/list/provided HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

pageToken

string

No

The pagination token. Use this token to retrieve the next page of results. If this parameter is not returned, pass an empty string ("").

""

maxResults

integer

No

The maximum number of records to return.

1000

Response elements

Element

Type

Description

Example

object

nextPageToken

string

The token to retrieve the next page of results. A null value indicates that this is the last page.

""

shares

array

The shares.

Share

The details of a share.

Examples

Success response

JSON format

{
  "nextPageToken": "\"\"",
  "shares": [
    {
      "providerTenantId": 0,
      "shareId": "",
      "shareName": "",
      "comment": "",
      "owner": "",
      "createdAt": 0,
      "createdBy": "",
      "updatedAt": 0,
      "updatedBy": "",
      "enableWrite": true
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.