Skip to content

List Principals

ram_list_principals R Documentation

Lists the principals that you are sharing resources with or that are sharing resources with you

Description

Lists the principals that you are sharing resources with or that are sharing resources with you.

Usage

ram_list_principals(resourceOwner, resourceArn, principals,
  resourceType, resourceShareArns, nextToken, maxResults)

Arguments

resourceOwner

[required] Specifies that you want to list information for only resource shares that match the following:

  • SELF – principals that your account is sharing resources with

  • OTHER-ACCOUNTS – principals that are sharing resources with your account

resourceArn

Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).

principals

Specifies that you want to list information for only the listed principals.

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.

resourceType

Specifies that you want to list information for only principals associated with resource shares that include the specified resource type.

For a list of valid values, query the list_resource_types operation.

resourceShareArns

Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).

nextToken

Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

maxResults

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Value

A list with the following syntax: 

list(
  principals = list(
    list(
      id = "string",
      resourceShareArn = "string",
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      external = TRUE|FALSE
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_principals(
  resourceOwner = "SELF"|"OTHER-ACCOUNTS",
  resourceArn = "string",
  principals = list(
    "string"
  ),
  resourceType = "string",
  resourceShareArns = list(
    "string"
  ),
  nextToken = "string",
  maxResults = 123
)