ListPrincipals
Lists the principals that you are sharing resources with or that are sharing resources with you.
Note
Always check the NextToken
response parameter for a null
value
when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more
results available. The NextToken
response parameter value is null
only
when there are no more results to display.
Request Syntax
POST /listprincipals HTTP/1.1
Content-type: application/json
{
"maxResults": number
,
"nextToken": "string
",
"principals": [ "string
" ],
"resourceArn": "string
",
"resourceOwner": "string
",
"resourceShareArns": [ "string
" ],
"resourceType": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- resourceOwner
-
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
Type: String
Valid Values:
SELF | OTHER-ACCOUNTS
Required: Yes
-
- 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 theNextToken
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 checkNextToken
after every operation to ensure that you receive all of the results.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 500.
Required: No
- 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'sNextToken
response to request the next page of results.Type: String
Required: No
- 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 Amazon Organizations, for example:
arn:aws:organizations::123456789012:organization/o-exampleorgid
-
An ARN of an organizational unit (OU) in Amazon Organizations, for example:
arn:aws:organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
-
An ARN of an IAM role, for example:
arn:aws:iam::123456789012:role/rolename
-
An ARN of an IAM user, for example:
arn:aws:iam::123456789012user/username
-
A service principal name, for example:
service-id.amazonaws.com
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 Amazon Resource Access Manager User Guide.
Type: Array of strings
Required: No
-
- resourceArn
-
Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).
Type: String
Required: No
-
Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).
Type: Array of strings
Required: No
- 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 ListResourceTypes operation.
Type: String
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"principals": [
{
"creationTime": number,
"external": boolean,
"id": "string",
"lastUpdatedTime": number,
"resourceShareArn": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- nextToken
-
If present, this value indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. This indicates that this is the last page of results.Type: String
- principals
-
An array of objects that contain the details about the principals.
Type: Array of Principal objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidNextTokenException
-
The operation failed because the specified value for
NextToken
isn't valid. You must specify a value you received in theNextToken
response of a previous call to this operation.HTTP Status Code: 400
- InvalidParameterException
-
The operation failed because a parameter you specified isn't valid.
HTTP Status Code: 400
- MalformedArnException
-
The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.
HTTP Status Code: 400
- ServerInternalException
-
The operation failed because the service could not respond to the request due to an internal problem. Try again later.
HTTP Status Code: 500
- ServiceUnavailableException
-
The operation failed because the service isn't available. Try again later.
HTTP Status Code: 503
- UnknownResourceException
-
The operation failed because a specified resource couldn't be found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: