All Products
Search
Document Center

Data Lake Formation:ListReceivedShares

Last Updated:Dec 16, 2025

Retrieves received 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/received HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

pageToken

string

No

The token to retrieve the next page of results. If the response does not include this token, pass an empty string ("").

""

maxResults

integer

No

The maximum number of records to return for this request.

1000

Response elements

Element

Type

Description

Example

object

The response body.

nextPageToken

string

The token to retrieve the next page of results. If this parameter is null, all results have been returned.

""

shares

array

The received shares.

ReceivedShare

The details of a received share.

Examples

Success response

JSON format

{
  "nextPageToken": "\"\"",
  "shares": [
    {
      "providerTenantId": 1111,
      "shareId": "1111",
      "shareName": "share_name",
      "owner": "acs:ram::[accountId]:root",
      "createdAt": 1744970111419,
      "createdBy": "acs:ram::[accountId]:root",
      "updatedAt": 1744970111419,
      "updatedBy": "acs:ram::[accountId]:root",
      "catalogName": "catalog_name",
      "comment": "demo"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.