ListPrincipalsRequest
import type { ListPrincipalsRequest } from "https://aws-api.deno.dev/v0.4/services/ram.ts?docs=full";
§Properties
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.
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.
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 Resoure 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
Note: 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.
Specifies that you want to list principal information for the resource share with the specified Amazon Resoure Name (ARN).
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