Skip to content

Replace Permission Associations

ram_replace_permission_associations R Documentation

Updates all resource shares that use a managed permission to a different managed permission

Description

Updates all resource shares that use a managed permission to a different managed permission. This operation always applies the default version of the target managed permission. You can optionally specify that the update applies to only resource shares that currently use a specified version. This enables you to update to the latest version, without changing the which managed permission is used.

You can use this operation to update all of your resource shares to use the current default version of the permission by specifying the same value for the fromPermissionArn and toPermissionArn parameters.

You can use the optional fromPermissionVersion parameter to update only those resources that use a specified version of the managed permission to the new managed permission.

To successfully perform this operation, you must have permission to update the resource-based policy on all affected resource types.

Usage

ram_replace_permission_associations(fromPermissionArn,
  fromPermissionVersion, toPermissionArn, clientToken)

Arguments

fromPermissionArn

[required] Specifies the Amazon Resource Name (ARN) of the managed permission that you want to replace.

fromPermissionVersion

Specifies that you want to updated the permissions for only those resource shares that use the specified version of the managed permission.

toPermissionArn

[required] Specifies the ARN of the managed permission that you want to associate with resource shares in place of the one specified by fromPerssionArn and fromPermissionVersion.

The operation always associates the version that is currently the default for the specified managed permission.

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(
  replacePermissionAssociationsWork = list(
    id = "string",
    fromPermissionArn = "string",
    fromPermissionVersion = "string",
    toPermissionArn = "string",
    toPermissionVersion = "string",
    status = "IN_PROGRESS"|"COMPLETED"|"FAILED",
    statusMessage = "string",
    creationTime = as.POSIXct(
      "2015-01-01"
    ),
    lastUpdatedTime = as.POSIXct(
      "2015-01-01"
    )
  ),
  clientToken = "string"
)

Request syntax

svc$replace_permission_associations(
  fromPermissionArn = "string",
  fromPermissionVersion = 123,
  toPermissionArn = "string",
  clientToken = "string"
)