UpdateResourceShare - AWS RAM

UpdateResourceShare

Modifies some of the properties of the specified resource share.

Request Syntax

POST /updateresourceshare HTTP/1.1 Content-type: application/json { "allowExternalPrincipals": boolean, "clientToken": "string", "name": "string", "resourceShareArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

resourceShareArn

Specifies the Amazon Resoure Name (ARN) of the resource share that you want to modify.

Type: String

Required: Yes

allowExternalPrincipals

Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share.

Type: Boolean

Required: No

clientToken

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then AWS generates a random one for you.

Type: String

Required: No

name

If specified, the new name that you want to attach to the resource share.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "clientToken": "string", "resourceShare": { "allowExternalPrincipals": boolean, "creationTime": number, "featureSet": "string", "lastUpdatedTime": number, "name": "string", "owningAccountId": "string", "resourceShareArn": "string", "status": "string", "statusMessage": "string", "tags": [ { "key": "string", "value": "string" } ] } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

clientToken

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

Type: String

resourceShare

Information about the resource share.

Type: ResourceShare object

Errors

For information about the errors that are common to all actions, see Common Errors.

IdempotentParameterMismatchException

The client token input parameter was matched one used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

HTTP Status Code: 400

InvalidClientTokenException

The client token is not valid.

HTTP Status Code: 400

InvalidParameterException

A parameter is not valid.

HTTP Status Code: 400

MalformedArnException

The format of an Amazon Resource Name (ARN) is not valid.

HTTP Status Code: 400

MissingRequiredParameterException

A required input parameter is missing.

HTTP Status Code: 400

OperationNotPermittedException

The requested operation is not permitted.

HTTP Status Code: 400

ServerInternalException

The service could not respond to the request due to an internal problem.

HTTP Status Code: 500

ServiceUnavailableException

The service is not available.

HTTP Status Code: 503

UnknownResourceException

A specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: