IAM / Client / get_service_last_accessed_details

get_service_last_accessed_details#

IAM.Client.get_service_last_accessed_details(**kwargs)#

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.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.get_service_last_accessed_details(
    JobId='string',
    MaxItems=123,
    Marker='string'
)
Parameters:

  • JobId (string) –

    [REQUIRED]

    The ID of the request generated by the GenerateServiceLastAccessedDetails operation. The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.

  • MaxItems (integer) –

    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 IsTruncated response element is true.

    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 IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

  • Marker (string) – 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 Marker element in the response that you received to indicate where the next call should start.

Return type:

dict

Returns:

Response Syntax

{
    'JobStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED',
    'JobType': 'SERVICE_LEVEL'|'ACTION_LEVEL',
    'JobCreationDate': datetime(2015, 1, 1),
    'ServicesLastAccessed': [
        {
            'ServiceName': 'string',
            'LastAuthenticated': datetime(2015, 1, 1),
            'ServiceNamespace': 'string',
            'LastAuthenticatedEntity': 'string',
            'LastAuthenticatedRegion': 'string',
            'TotalAuthenticatedEntities': 123,
            'TrackedActionsLastAccessed': [
                {
                    'ActionName': 'string',
                    'LastAccessedEntity': 'string',
                    'LastAccessedTime': datetime(2015, 1, 1),
                    'LastAccessedRegion': 'string'
                },
            ]
        },
    ],
    'JobCompletionDate': datetime(2015, 1, 1),
    'IsTruncated': True|False,
    'Marker': 'string',
    'Error': {
        'Message': 'string',
        'Code': 'string'
    }
}

Response Structure

  • (dict) –

    • JobStatus (string) –

      The status of the job.

    • JobType (string) –

      The type of job. Service jobs return information about when each service was last accessed. Action jobs also include information about when tracked actions within the service were last accessed.

    • JobCreationDate (datetime) –

      The date and time, in  ISO 8601 date-time format, when the report job was created.

    • ServicesLastAccessed (list) –

      A  ServiceLastAccessed object that contains details about the most recent attempt to access the service.

      • (dict) –

        Contains details about the most recent attempt to access the service.

        This data type is used as a response element in the GetServiceLastAccessedDetails operation.

        • ServiceName (string) –

          The name of the service in which access was attempted.

        • LastAuthenticated (datetime) –

          The date and time, in  ISO 8601 date-time format, when an authenticated entity most recently attempted to access the service. Amazon Web Services does not report unauthenticated requests.

          This field is null if no IAM entities attempted to access the service within the tracking period.

        • ServiceNamespace (string) –

          The namespace of the service in which access was attempted.

          To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization Reference. 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 Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

        • LastAuthenticatedEntity (string) –

          The ARN of the authenticated entity (user or role) that last attempted to access the service. Amazon Web Services does not report unauthenticated requests.

          This field is null if no IAM entities attempted to access the service within the tracking period.

        • LastAuthenticatedRegion (string) –

          The Region from which the authenticated entity (user or role) last attempted to access the service. Amazon Web Services does not report unauthenticated requests.

          This field is null if no IAM entities attempted to access the service within the tracking period.

        • TotalAuthenticatedEntities (integer) –

          The total number of authenticated principals (root user, IAM users, or IAM roles) that have attempted to access the service.

          This field is null if no principals attempted to access the service within the tracking period.

        • TrackedActionsLastAccessed (list) –

          An object that contains details about the most recent attempt to access a tracked action within the service.

          This field is null if there no tracked actions or if the principal did not use the tracked actions within the tracking period. This field is also null if the report was generated at the service level and not the action level. For more information, see the Granularity field in GenerateServiceLastAccessedDetails.

          • (dict) –

            Contains details about the most recent attempt to access an action within the service.

            This data type is used as a response element in the GetServiceLastAccessedDetails operation.

            • ActionName (string) –

              The name of the tracked action to which access was attempted. Tracked actions are actions that report activity to IAM.

            • LastAccessedEntity (string) –

              The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

              For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

            • LastAccessedTime (datetime) –

              The date and time, in  ISO 8601 date-time format, when an authenticated entity most recently attempted to access the tracked service. Amazon Web Services does not report unauthenticated requests.

              This field is null if no IAM entities attempted to access the service within the tracking period.

            • LastAccessedRegion (string) –

              The Region from which the authenticated entity (user or role) last attempted to access the tracked action. Amazon Web Services does not report unauthenticated requests.

              This field is null if no IAM entities attempted to access the service within the tracking period.

    • JobCompletionDate (datetime) –

      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.

    • IsTruncated (boolean) –

      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 Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • Marker (string) –

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

    • Error (dict) –

      An object that contains details about the reason the operation failed.

      • Message (string) –

        Detailed information about the reason that the operation failed.

      • Code (string) –

        The error code associated with the operation failure.

Exceptions

  • IAM.Client.exceptions.NoSuchEntityException

  • IAM.Client.exceptions.InvalidInputException

Examples

The following operation gets details about the report with the job ID: examplef-1305-c245-eba4-71fe298bcda7

response = client.get_service_last_accessed_details(
    JobId='examplef-1305-c245-eba4-71fe298bcda7',
)

print(response)

Expected Output:

{
    'IsTruncated': False,
    'JobCompletionDate': datetime(2018, 10, 24, 19, 47, 35, 2, 297, 0),
    'JobCreationDate': datetime(2018, 10, 24, 19, 47, 31, 2, 297, 0),
    'JobStatus': 'COMPLETED',
    'ServicesLastAccessed': [
        {
            'LastAuthenticated': datetime(2018, 10, 24, 19, 11, 0, 2, 297, 0),
            '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,
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}