principals
Creates, updates, deletes, gets or lists a principals resource.
Overview
| Name | principals |
| Type | Resource |
| Id | aws.ram.principals |
Fields
The following fields are returned by SELECT queries:
- list_principals
| Name | Datatype | Description |
|---|---|---|
id | string | The ID of the principal that can be associated with a resource share. |
creation_time | string (date-time) | The date and time when the principal was associated with the resource share. |
external | boolean | Indicates the relationship between the Amazon Web Services account the principal belongs to and the account that owns the resource share: True – The two accounts belong to same organization. False – The two accounts do not belong to the same organization. |
last_updated_time | string (date-time) | The date and time when the association between the resource share and the principal was last updated. |
resource_share_arn | string | The Amazon Resource Name (ARN) of a resource share the principal is associated with. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_principals | select | region | Lists the principals that you are sharing resources with or that are sharing resources with you. 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_principals
Lists the principals that you are sharing resources with or that are sharing resources with you. 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.
SELECT
id,
creation_time,
external,
last_updated_time,
resource_share_arn
FROM aws.ram.principals
WHERE region = '{{ region }}' -- required
;