Updating a Resource Share

Function

This API is used to modify the properties of a resource share.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

PUT /v1/resource-shares/{resource_share_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
resource_share_id	Yes	String	ID of the resource share. Minimum: 0 Maximum: 36

Request Parameters

**Table 2** 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 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Name of the resource share. Minimum: 1 Maximum: 64
description	No	String	Description of the resource share. Minimum: 0 Maximum: 256
allow_external_principals	No	Boolean	Whether resources can be shared with any accounts outside the organization.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
resource_share	ResourceShare object	Describes a resource share in RAM.

**Table 5** ResourceShare
Parameter	Type	Description
id	String	ID of the resource share. Minimum: 0 Maximum: 36
name	String	Name of the resource share. Minimum: 0 Maximum: 128
description	String	Description of the resource share. Minimum: 1 Maximum: 1024
allow_external_principals	Boolean	Whether resources can be shared with any accounts outside the organization.
owning_account_id	String	ID of the resource owner in a resource share. Minimum: 0 Maximum: 36
status	String	Status of the resource share. Minimum: 0 Maximum: 36
tags	Array of Tag objects	List of tags attached to the resource share. Array Length: 0 - 100
created_at	String	Time when the resource share was created.
updated_at	String	Time when the resource share was last updated.

**Table 6** Tag
Parameter	Type	Description
key	String	Identifier or name of the tag key. Minimum: 1 Maximum: 128
value	String	Tag value. You can set the tag value to an empty string but not to null. Minimum: 0 Maximum: 255

Example Requests

Modifying the name or description of a resource share

PUT https://{hostname}/v1/resource-shares/{resource_share_id}

{
  "name" : "string",
  "description" : "string"
}

Example Responses

Status code: 200

Request succeeded.

{
  "resource_share" : {
    "id" : "string",
    "name" : "string",
    "description" : "string",
    "allow_external_principals" : true,
    "owning_account_id" : "string",
    "status" : "string",
    "tags" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "created_at" : "2023-01-30T11:29:17.578Z",
    "updated_at" : "2023-01-30T11:29:17.578Z"
  }
}