Delete Permission Version

ram_delete_permission_version

R Documentation

Deletes one version of a customer managed permission

Description

Deletes one version of a customer managed permission. The version you specify must not be attached to any resource share and must not be the default version for the permission.

If a customer managed permission has the maximum of 5 versions, then you must delete at least one version before you can create another.

Usage

ram_delete_permission_version(permissionArn, permissionVersion,
  clientToken)

Arguments

permissionArn

[required] Specifies the Amazon Resource Name (ARN) of the permission with the version you want to delete.

permissionVersion

[required] Specifies the version number to delete.

You can't delete the default version for a customer managed permission.

You can't delete a version if it's the only version of the permission. You must either first create another version, or delete the permission completely.

You can't delete a version if it is attached to any resource shares. If the version is the default, you must first use set_default_permission_version to set a different version as the default for the customer managed permission, and then use associate_resource_share_permission to update your resource shares to use the new default version.

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 Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Value

A list with the following syntax:

list(
  returnValue = TRUE|FALSE,
  clientToken = "string",
  permissionStatus = "ATTACHABLE"|"UNATTACHABLE"|"DELETING"|"DELETED"
)

Request syntax

svc$delete_permission_version(
  permissionArn = "string",
  permissionVersion = 123,
  clientToken = "string"
)