Searching for Distinct Shared Resources

Function

This API is used to search for distinct resources that you share or are shared with you.

URI

POST /v1/shared-resources/search-distinct-resource

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of results on a page. If the limit parameter is not specified, the default value is 2,000.
marker	No	String	Page marker.
resource_ids	No	Array of strings	Resource ID.
principal	No	String	Principal associated with the resource share.
resource_region	No	String	Region where the resource is located.
resource_urns	No	Array of strings	List of resource URNs.
resource_owner	Yes	String	Resource owner (self or other-accounts) of the resource share.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
distinct_shared_resources	Array of DistinctSharedResource objects	List of distinct resources.
page_info	PageInfo object	Pagination details.

**Table 4** DistinctSharedResource
Parameter	Type	Description
resource_urn	String	Uniform resource name of the resource.
resource_type	String	Resource type.
updated_at	String	Time when the resource share was last updated.

**Table 5** PageInfo
Parameter	Type	Description
previous_marker	String	Marker of the previous page.
next_marker	String	Marker of the next page.
current_count	Integer	Number of pages.

Example Requests

Searching for distinct resources that you share or are shared with you

POST https://{endpoint}/v1/shared-resources/search-distinct-resource

{
  "limit" : 2000,
  "marker" : "string",
  "resource_ids" : [ "string" ],
  "principal" : "string",
  "resource_region" : "string",
  "resource_urns" : [ "string" ],
  "resource_owner" : "self"
}

Example Responses

Status code: 200

Request succeeded.

{
  "distinct_shared_resources" : [ {
    "resource_urn" : "string",
    "resource_type" : "string",
    "updated_at" : "2022-09-19T02:32:48.943Z"
  } ],
  "page_info" : {
    "previous_marker" : "string",
    "next_marker" : "string",
    "current_count" : 2000
  }
}