Class GetServiceLastAccessedDetailsCommandProtected

Retrieves a service last accessed report that was created using the GenerateServiceLastAccessedDetails operation. You can use the JobId parameter in GetServiceLastAccessedDetails to retrieve the status of your report job. When the report is complete, you can retrieve the generated report. The report includes a list of Amazon Web Services services that the resource (user, group, role, or managed policy) can access.

Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.

For each service that the resource could access using permissions policies, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails operation returns the reason that it failed.

The GetServiceLastAccessedDetails operation returns a list of services. This list includes the number of entities that have attempted to access the service and the date and time of the last attempt. It also returns the ARN of the following entity, depending on the resource ARN that you used to generate the report:

• User – Returns the user ARN that you used to generate the report

• Group – Returns the ARN of the group member (user) that last attempted to access the service

• Role – Returns the role ARN that you used to generate the report

• Policy – Returns the ARN of the user or role that last used the policy to attempt to access the service

By default, the list is sorted by service namespace.

If you specified ACTION_LEVEL granularity when you generated the report, this operation returns service and action last accessed data. This includes the most recent access attempt for each tracked action within a service. Otherwise, this operation returns only service data.

For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.

Example

Use a bare-bones client and the command you need to make an API call.

import { IAMClient, GetServiceLastAccessedDetailsCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, GetServiceLastAccessedDetailsCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // GetServiceLastAccessedDetailsRequest
  JobId: "STRING_VALUE", // required
  MaxItems: Number("int"),
  Marker: "STRING_VALUE",
};
const command = new GetServiceLastAccessedDetailsCommand(input);
const response = await client.send(command);
// { // GetServiceLastAccessedDetailsResponse
//   JobStatus: "IN_PROGRESS" || "COMPLETED" || "FAILED", // required
//   JobType: "SERVICE_LEVEL" || "ACTION_LEVEL",
//   JobCreationDate: new Date("TIMESTAMP"), // required
//   ServicesLastAccessed: [ // ServicesLastAccessed // required
//     { // ServiceLastAccessed
//       ServiceName: "STRING_VALUE", // required
//       LastAuthenticated: new Date("TIMESTAMP"),
//       ServiceNamespace: "STRING_VALUE", // required
//       LastAuthenticatedEntity: "STRING_VALUE",
//       LastAuthenticatedRegion: "STRING_VALUE",
//       TotalAuthenticatedEntities: Number("int"),
//       TrackedActionsLastAccessed: [ // TrackedActionsLastAccessed
//         { // TrackedActionLastAccessed
//           ActionName: "STRING_VALUE",
//           LastAccessedEntity: "STRING_VALUE",
//           LastAccessedTime: new Date("TIMESTAMP"),
//           LastAccessedRegion: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
//   JobCompletionDate: new Date("TIMESTAMP"), // required
//   IsTruncated: true || false,
//   Marker: "STRING_VALUE",
//   Error: { // ErrorDetails
//     Message: "STRING_VALUE", // required
//     Code: "STRING_VALUE", // required
//   },
// };

Param

GetServiceLastAccessedDetailsCommandInput

Returns

GetServiceLastAccessedDetailsCommandOutput

See

• GetServiceLastAccessedDetailsCommandInput for command's input shape.
• GetServiceLastAccessedDetailsCommandOutput for command's response shape.
• config for IAMClient's config shape.

Throws

InvalidInputException (client fault)

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

Throws

NoSuchEntityException (client fault)

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

Throws

IAMServiceException

Base exception class for all service exceptions from IAM service.

Example

To get details from a previously-generated report

// The following operation gets details about the report with the job ID: examplef-1305-c245-eba4-71fe298bcda7
const input = {
  "JobId": "examplef-1305-c245-eba4-71fe298bcda7"
};
const command = new GetServiceLastAccessedDetailsCommand(input);
const response = await client.send(command);
/* response ==
{
  "IsTruncated": false,
  "JobCompletionDate": "2018-10-24T19:47:35.241Z",
  "JobCreationDate": "2018-10-24T19:47:31.466Z",
  "JobStatus": "COMPLETED",
  "ServicesLastAccessed": [
    {
      "LastAuthenticated": "2018-10-24T19:11:00Z",
      "LastAuthenticatedEntity": "arn:aws:iam::123456789012:user/AWSExampleUser01",
      "ServiceName": "AWS Identity and Access Management",
      "ServiceNamespace": "iam",
      "TotalAuthenticatedEntities": 2
    },
    {
      "ServiceName": "Amazon Simple Storage Service",
      "ServiceNamespace": "s3",
      "TotalAuthenticatedEntities": 0
    }
  ]
}
*/
// example id: getserviceaccessdetails-policy-1541696298085