ListThingPrincipalsV2
Lists the principals associated with the specified thing. A principal can be an X.509 certificate or an Amazon Cognito ID.
Requires permission to access the ListThingPrincipals action.
Request Syntax
GET /things/thingName/principals-v2?maxResults=maxResults&nextToken=nextToken&thingPrincipalType=thingPrincipalType HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results to return in this operation.
Valid Range: Minimum value of 1. Maximum value of 250.
- nextToken
-
To retrieve the next set of results, the
nextTokenvalue from a previous response; otherwise null to receive the first set of results. - thingName
-
The name of the thing.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9:_-]+Required: Yes
- thingPrincipalType
-
The type of the relation you want to filter in the response. If no value is provided in this field, the response will list all principals, including both the
EXCLUSIVE_THINGandNON_EXCLUSIVE_THINGattachment types.-
EXCLUSIVE_THING- Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.
-
NON_EXCLUSIVE_THING- Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.
Valid Values:
EXCLUSIVE_THING | NON_EXCLUSIVE_THING -
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"thingPrincipalObjects": [
{
"principal": "string",
"thingPrincipalType": "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 get the next set of results, or null if there are no additional results.
Type: String
- thingPrincipalObjects
-
A list of
thingPrincipalObjectthat represents the principal and the type of relation it has with the thing.Type: Array of ThingPrincipalObject objects
Errors
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 503
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
- UnauthorizedException
-
You are not authorized to perform this operation.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
