GetServiceLastAccessedDetailsWithEntities
After you generate a group or policy report using the
GenerateServiceLastAccessedDetails operation, you can use the
JobId parameter in
GetServiceLastAccessedDetailsWithEntities. This operation retrieves the
status of your report job and a list of entities that could have used group or policy
permissions to access the specified service.
-
Group – For a group report, this operation returns a list of users in the group that could have used the group’s policies in an attempt to access the service.
-
Policy – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service.
You can also use this operation for user or role reports to retrieve details about those entities.
If the operation fails, the GetServiceLastAccessedDetailsWithEntities
operation returns the reason that it failed.
By default, the list of associated entities is sorted by date, with the most recent access listed first.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- JobId
-
The ID of the request generated by the
GenerateServiceLastAccessedDetailsoperation.Type: String
Length Constraints: Fixed length of 36.
Required: Yes
- Marker
-
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the
Markerelement in the response that you received to indicate where the next call should start.Type: String
Length Constraints: Minimum length of 1.
Pattern:
[\u0020-\u00FF]+Required: No
- MaxItems
-
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the
IsTruncatedresponse element istrue.If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the
IsTruncatedresponse element returnstrue, andMarkercontains a value to include in the subsequent call that tells the service where to continue from.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- ServiceNamespace
-
The service namespace for an AWS service. Provide the service namespace to learn when the IAM entity last attempted to access the specified service.
To learn the service namespace for a service, see Actions, resources, and condition keys for AWS services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example,
(service prefix: a4b). For more information about service namespaces, see AWS service namespaces in the AWS General Reference.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\w-]*Required: Yes
Response Elements
The following elements are returned by the service.
- EntityDetailsList.member.N
-
An
EntityDetailsListobject that contains details about when an IAM entity (user or role) used group or policy permissions in an attempt to access the specified AWS service.Type: Array of EntityDetails objects
- Error
-
An object that contains details about the reason the operation failed.
Type: ErrorDetails object
- IsTruncated
-
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the
Markerrequest parameter to retrieve more items. Note that IAM might return fewer than theMaxItemsnumber of results even when there are more results available. We recommend that you checkIsTruncatedafter every call to ensure that you receive all your results.Type: Boolean
- JobCompletionDate
-
The date and time, in ISO 8601 date-time format
, when the generated report job was completed or failed. This field is null if the job is still in progress, as indicated by a job status value of
IN_PROGRESS.Type: Timestamp
- JobCreationDate
-
The date and time, in ISO 8601 date-time format
, when the report job was created. Type: Timestamp
- JobStatus
-
The status of the job.
Type: String
Valid Values:
IN_PROGRESS | COMPLETED | FAILED - Marker
-
When
IsTruncatedistrue, this element is present and contains the value to use for theMarkerparameter in a subsequent pagination request.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidInput
-
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
HTTP Status Code: 400
- NoSuchEntity
-
The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
HTTP Status Code: 404
Examples
Example
This example illustrates one usage of GetServiceLastAccessedDetailsWithEntities.
Sample Request
https://iam.amazonaws.com/?Action=GetServiceLastAccessedDetailsWithEntities
&JobId=examplef-1305-c245-eba4-71fe298bcda7
&ServiceNamespace=iam
&Version=2010-05-08
&AUTHPARAMSSample Response
<EntityDetailsList>
<member>
<EntityInfo>
<Arn>arn:aws:iam::123456789012:user/AWSExampleUser01</Arn>
<Id>AIDAEX2EXAMPLEB6IGCDC</Id>
<Name>AWSExampleUser01</Name>
<Path>/</Path>
<Type>USER</Type>
</EntityInfo>
<LastAuthenticated>2018-10-24T19:10:00Z</LastAuthenticated>
</member>
<member>
<EntityInfo>
<Arn>arn:aws:iam::072398337363:role/AWSExampleRole01</Arn>
<Id>AROAEAW2EXAMPLENXSIU4</Id>
<Name>AWSExampleRole01</Name>
<Path>/</Path>
<Type>ROLE</Type>
</EntityInfo>
</member>
</EntityDetailsList>
<IsTruncated>false</IsTruncated>
<JobCompletionDate>2018-10-24T19:47:35.241Z</JobCompletionDate>
<JobCreationDate>2018-10-24T19:47:31.466Z</JobCreationDate>
<JobStatus>COMPLETED</JobStatus>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
