IAM / Client / get_service_last_accessed_details_with_entities

get_service_last_accessed_details_with_entities#

IAM.Client.get_service_last_accessed_details_with_entities(**kwargs)#

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 Syntax

response = client.get_service_last_accessed_details_with_entities(
    JobId='string',
    ServiceNamespace='string',
    MaxItems=123,
    Marker='string'
)

Parameters:

JobId (string) –
[REQUIRED]

The ID of the request generated by the GenerateServiceLastAccessedDetails operation.
ServiceNamespace (string) –
[REQUIRED]

The service namespace for an Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services service namespaces in the Amazon Web Services General Reference.
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',
    'JobCreationDate': datetime(2015, 1, 1),
    'JobCompletionDate': datetime(2015, 1, 1),
    'EntityDetailsList': [
        {
            'EntityInfo': {
                'Arn': 'string',
                'Name': 'string',
                'Type': 'USER'|'ROLE'|'GROUP',
                'Id': 'string',
                'Path': 'string'
            },
            'LastAuthenticated': datetime(2015, 1, 1)
        },
    ],
    'IsTruncated': True|False,
    'Marker': 'string',
    'Error': {
        'Message': 'string',
        'Code': 'string'
    }
}

Response Structure

(dict) –
- JobStatus (string) –
  
  The status of the job.
- JobCreationDate (datetime) –
  
  The date and time, in ISO 8601 date-time format, when the report job was created.
- 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.
- EntityDetailsList (list) –
  
  An EntityDetailsList object that contains details about when an IAM entity (user or role) used group or policy permissions in an attempt to access the specified Amazon Web Services service.
  - (dict) –
    
    An object that contains details about when the IAM entities (users or roles) were last used in an attempt to access the specified Amazon Web Services service.
    
    This data type is a response element in the GetServiceLastAccessedDetailsWithEntities operation.
    - EntityInfo (dict) –
      
      The EntityInfo object that contains details about the entity (user or role).
      - Arn (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.
      - Name (string) –
        
        The name of the entity (user or role).
      - Type (string) –
        
        The type of entity (user or role).
      - Id (string) –
        
        The identifier of the entity (user or role).
      - Path (string) –
        
        The path to the entity (user or role). For more information about paths, see IAM identifiers in the IAM User Guide.
    - LastAuthenticated (datetime) –
      
      The date and time, in ISO 8601 date-time format, when the authenticated entity last attempted to access Amazon Web Services. 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.
- 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 returns details about the entities that attempted to access the IAM service.

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

print(response)

Expected Output:

{
    'EntityDetailsList': [
        {
            'EntityInfo': {
                'Arn': 'arn:aws:iam::123456789012:user/AWSExampleUser01',
                'Id': 'AIDAEX2EXAMPLEB6IGCDC',
                'Name': 'AWSExampleUser01',
                'Path': '/',
                'Type': 'USER',
            },
            'LastAuthenticated': datetime(2018, 10, 24, 19, 10, 0, 2, 297, 0),
        },
        {
            'EntityInfo': {
                'Arn': 'arn:aws:iam::123456789012:role/AWSExampleRole01',
                'Id': 'AROAEAEXAMPLEIANXSIU4',
                'Name': 'AWSExampleRole01',
                'Path': '/',
                'Type': 'ROLE',
            },
        },
    ],
    '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',
    'ResponseMetadata': {
        '...': '...',
    },
}