subjects
Creates, updates, deletes, gets or lists a subjects resource.
Overview
| Name | subjects |
| Type | Resource |
| Id | aws.rolesanywhere.subjects |
Fields
The following fields are returned by SELECT queries:
- get_subject
- list_subjects
| Name | Datatype | Description |
|---|---|---|
created_at | string (date-time) | The ISO-8601 timestamp when the subject was created. |
credentials | array | The temporary session credentials vended at the last authenticating call with this subject. |
enabled | boolean | The enabled status of the subject. |
instance_properties | array | The specified instance properties associated with the request. |
last_seen_at | string (date-time) | The ISO-8601 timestamp of the last time this subject requested temporary session credentials. |
subject_arn | string | The ARN of the resource. |
subject_id | string | The id of the resource (pattern: <code>.[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}.</code>) |
updated_at | string (date-time) | The ISO-8601 timestamp when the subject was last updated. |
x_509_subject | string | The x509 principal identifier of the authenticating certificate. |
| Name | Datatype | Description |
|---|---|---|
created_at | string (date-time) | The ISO-8601 time stamp of when the certificate was first used in a temporary credential request. |
enabled | boolean | The enabled status of the subject. |
last_seen_at | string (date-time) | The ISO-8601 time stamp of when the certificate was last used in a temporary credential request. |
subject_arn | string | The ARN of the resource. |
subject_id | string | The id of the resource. (pattern: <code>.[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}.</code>) |
updated_at | string (date-time) | The ISO-8601 timestamp when the subject was last updated. |
x_509_subject | string | The x509 principal identifier of the authenticating certificate. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_subject | select | subject_id, region | Gets a subject, which associates a certificate identity with authentication attempts. The subject stores auditing information such as the status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication. Required permissions: rolesanywhere:GetSubject. | |
list_subjects | select | region | nextToken, pageSize | Lists the subjects in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListSubjects. |
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) |
subject_id | string | The unique identifier of the subject. |
nextToken | string | A token that indicates where the output should continue from, if a previous request did not show all results. To get the next results, make the request again with this value. |
pageSize | integer | The number of resources in the paginated list. |
SELECT examples
- get_subject
- list_subjects
Gets a subject, which associates a certificate identity with authentication attempts. The subject stores auditing information such as the status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication. Required permissions: rolesanywhere:GetSubject.
SELECT
created_at,
credentials,
enabled,
instance_properties,
last_seen_at,
subject_arn,
subject_id,
updated_at,
x_509_subject
FROM aws.rolesanywhere.subjects
WHERE subject_id = '{{ subject_id }}' -- required
AND region = '{{ region }}' -- required
;
Lists the subjects in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListSubjects.
SELECT
created_at,
enabled,
last_seen_at,
subject_arn,
subject_id,
updated_at,
x_509_subject
FROM aws.rolesanywhere.subjects
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND pageSize = '{{ pageSize }}'
;