ram_disassociate_resource_share: Removes the specified principals or resources from...

View source: R/ram_operations.R

ram_disassociate_resource_shareR Documentation

Removes the specified principals or resources from participating in the specified resource share

Description

Removes the specified principals or resources from participating in the specified resource share.

See https://www.paws-r-sdk.com/docs/ram_disassociate_resource_share/ for full documentation.

Usage

ram_disassociate_resource_share(
  resourceShareArn,
  resourceArns = NULL,
  principals = NULL,
  clientToken = NULL,
  sources = NULL
)

Arguments

resourceShareArn

[required] Specifies Amazon Resource Name (ARN) of the resource share that you want to remove resources or principals from.

resourceArns

Specifies a list of Amazon Resource Names (ARNs) for one or more resources that you want to remove from the resource share. After the operation runs, these resources are no longer shared with principals associated with the resource share.

principals

Specifies a list of one or more principals that no longer are to have access to the resources in this resource share.

You can include the following values:

  • An Amazon Web Services account ID, for example: 123456789012

  • An Amazon Resource Name (ARN) of an organization in Organizations, for example: ⁠organizations::123456789012:organization/o-exampleorgid⁠

  • An ARN of an organizational unit (OU) in Organizations, for example: ⁠organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123⁠

  • An ARN of an IAM role, for example: ⁠iam::123456789012:role/rolename⁠

  • An ARN of an IAM user, for example: ⁠iam::123456789012user/username⁠

Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

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.

sources

Specifies from which source accounts the service principal no longer has access to the resources in this resource share.


paws.security.identity documentation built on Sept. 12, 2024, 6:30 a.m.