IAM / Client / get_organizations_access_report

get_organizations_access_report#

IAM.Client.get_organizations_access_report(**kwargs)#

Retrieves the service last accessed data report for Organizations that was previously generated using the GenerateOrganizationsAccessReport operation. This operation retrieves the status of your report job and the report contents.

Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see GenerateOrganizationsAccessReport.

To call this operation, you must be signed in to the management account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see Refining permissions using service last accessed data in the IAM User Guide.

For each service that principals in an account (root user, IAM users, or IAM roles) could access using SCPs, 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, it returns the reason that it failed.

By default, the list is sorted by service namespace.

Request Syntax

response = client.get_organizations_access_report(
    JobId='string',
    MaxItems=123,
    Marker='string',
    SortKey='SERVICE_NAMESPACE_ASCENDING'|'SERVICE_NAMESPACE_DESCENDING'|'LAST_AUTHENTICATED_TIME_ASCENDING'|'LAST_AUTHENTICATED_TIME_DESCENDING'
)

Parameters:

JobId (string) –
[REQUIRED]

The identifier of the request generated by the GenerateOrganizationsAccessReport operation.
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.
SortKey (string) – The key that is used to sort the results. If you choose the namespace key, the results are returned in alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.

Return type:

dict

Returns:

Response Syntax

{
    'JobStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED',
    'JobCreationDate': datetime(2015, 1, 1),
    'JobCompletionDate': datetime(2015, 1, 1),
    'NumberOfServicesAccessible': 123,
    'NumberOfServicesNotAccessed': 123,
    'AccessDetails': [
        {
            'ServiceName': 'string',
            'ServiceNamespace': 'string',
            'Region': 'string',
            'EntityPath': 'string',
            'LastAuthenticatedTime': datetime(2015, 1, 1),
            'TotalAuthenticatedEntities': 123
        },
    ],
    'IsTruncated': True|False,
    'Marker': 'string',
    'ErrorDetails': {
        '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.
- NumberOfServicesAccessible (integer) –
  
  The number of services that the applicable SCPs allow account principals to access.
- NumberOfServicesNotAccessed (integer) –
  
  The number of services that account principals are allowed but did not attempt to access.
- AccessDetails (list) –
  
  An object that contains details about the most recent attempt to access the service.
  - (dict) –
    
    An object that contains details about when a principal in the reported Organizations entity last attempted to access an Amazon Web Services service. A principal can be an IAM user, an IAM role, or the Amazon Web Services account root user within the reported Organizations entity.
    
    This data type is a response element in the GetOrganizationsAccessReport operation.
    - ServiceName (string) –
      
      The name of the service in which access was attempted.
    - 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.
    - Region (string) –
      
      The Region where the last service access attempt occurred.
      
      This field is null if no principals in the reported Organizations entity attempted to access the service within the tracking period.
    - EntityPath (string) –
      
      The path of the Organizations entity (root, organizational unit, or account) from which an authenticated principal last attempted to access the service. Amazon Web Services does not report unauthenticated requests.
      
      This field is null if no principals (IAM users, IAM roles, or root user) in the reported Organizations entity attempted to access the service within the tracking period.
    - LastAuthenticatedTime (datetime) –
      
      The date and time, in ISO 8601 date-time format, when an authenticated principal most recently attempted to access the service. Amazon Web Services does not report unauthenticated requests.
      
      This field is null if no principals in the reported Organizations entity attempted to access the service within the tracking period.
    - TotalAuthenticatedEntities (integer) –
      
      The number of accounts with authenticated principals (root user, IAM users, and IAM roles) that attempted to access the service in 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.
- ErrorDetails (dict) –
  
  Contains information about the reason that the operation failed.
  
  This data type is used as a response element in the GetOrganizationsAccessReport, GetServiceLastAccessedDetails, and GetServiceLastAccessedDetailsWithEntities operations.
  - 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

Examples

The following operation gets details about the report with the job ID: examplea-1234-b567-cde8-90fg123abcd4

response = client.get_organizations_access_report(
    JobId='examplea-1234-b567-cde8-90fg123abcd4',
)

print(response)

Expected Output:

{
    'AccessDetails': [
        {
            'EntityPath': 'o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/111122223333',
            'LastAuthenticatedTime': datetime(2019, 5, 25, 16, 29, 52, 5, 145, 0),
            'Region': 'us-east-1',
            'ServiceName': 'Amazon DynamoDB',
            'ServiceNamespace': 'dynamodb',
            'TotalAuthenticatedEntities': 2,
        },
        {
            'EntityPath': 'o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/123456789012',
            'LastAuthenticatedTime': datetime(2019, 6, 15, 13, 12, 6, 5, 166, 0),
            'Region': 'us-east-1',
            'ServiceName': 'AWS Identity and Access Management',
            'ServiceNamespace': 'iam',
            'TotalAuthenticatedEntities': 4,
        },
        {
            'ServiceName': 'Amazon Simple Storage Service',
            'ServiceNamespace': 's3',
            'TotalAuthenticatedEntities': 0,
        },
    ],
    'IsTruncated': False,
    'JobCompletionDate': datetime(2019, 6, 18, 19, 47, 35, 1, 169, 0),
    'JobCreationDate': datetime(2019, 6, 18, 19, 47, 31, 1, 169, 0),
    'JobStatus': 'COMPLETED',
    'NumberOfServicesAccessible': 3,
    'NumberOfServicesNotAccessed': 1,
    'ResponseMetadata': {
        '...': '...',
    },
}