Searching for Shared Resources

Function

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

URI

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

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 entries that can be displayed on a page.
marker	No	String	Page marker.
principal	No	String	Principal associated with the resource share.
resource_ids	No	Array of strings	List of resource IDs.
resource_urns	No	Array of strings	List of resource URNs.
resource_owner	Yes	String	Resource owner (self or other-accounts) of the resource share.
resource_share_ids	No	Array of strings	List of resource share IDs.
resource_region	No	String	Region where the resource is located.
resource_type	No	String	Resource type.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
shared_resources	Array of SharedResource objects	List of shared resources.
page_info	PageInfo object	Pagination details.

**Table 4** SharedResource
Parameter	Type	Description
resource_urn	String	Uniform resource name of the resource.
created_at	String	Time when the resource was associated with the resource share.
updated_at	String	Time when the resource share was last updated.
resource_type	String	Resource type.
resource_share_id	String	ID of the resource share associated with the resource.
status	String	Status of the association.

**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 the resources that you share or are shared with you

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

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

Example Responses

Status code: 200

Request succeeded.

{
  "shared_resources" : [ {
    "resource_urn" : "string",
    "created_at" : "2022-09-19T02:32:23.735Z",
    "updated_at" : "2022-09-19T02:32:23.735Z",
    "resource_type" : "string",
    "resource_share_id" : "string",
    "status" : "string"
  } ],
  "page_info" : {
    "previous_marker" : "string",
    "next_marker" : "string",
    "current_count" : 2000
  }
}