AWS Resource Access Manager
API Reference (API Version 2018-01-04)

ListPrincipals

Lists the principals that you have shared resources with or the principals that have shared resources with you.

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.

maxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

nextToken

The token for the next page of results.

Type: String

Required: No

principals

The principals.

Type: Array of strings

Required: No

resourceArn

The Amazon Resource Name (ARN) of the resource.

Type: String

Required: No

resourceOwner

The type of owner.

Type: String

Valid Values: SELF | OTHER-ACCOUNTS

Required: Yes

resourceShareArns

The Amazon Resource Names (ARN) of the resource shares.

Type: Array of strings

Required: No

resourceType

The resource type.

Valid values: route53resolver:ResolverRule | ec2:TransitGateway | ec2:Subnet | license-manager:LicenseConfiguration

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

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

principals

The principals.

Type: Array of Principal objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidNextTokenException

The specified value for NextToken is not valid.

HTTP Status Code: 400

InvalidParameterException

A parameter is not valid.

HTTP Status Code: 400

MalformedArnException

The format of an Amazon Resource Name (ARN) is not valid.

HTTP Status Code: 400

ServerInternalException

The service could not respond to the request due to an internal problem.

HTTP Status Code: 500

ServiceUnavailableException

The service is not available.

HTTP Status Code: 503

UnknownResourceException

A specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: