AWS API Changes

2019/06/21 - AWS Identity and Access Management - 2 new api methods

Changes Update iam client to latest version

GetOrganizationsAccessReport (new)

Link ¶

Retrieves the service last accessed data report for AWS 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 master 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 users, 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.

See also: AWS API Documentation

Request Syntax

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'
)

type JobId:

string

param JobId:

[REQUIRED]

The identifier of the request generated by the GenerateOrganizationsAccessReport operation.

type MaxItems:

integer

param 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 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.

type Marker:

string

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

type SortKey:

string

param SortKey:

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.

rtype:

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 AWS Organizations entity last attempted to access an AWS service. A principal can be an IAM user, an IAM role, or the AWS 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, go to 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.
    - 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 reporting 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. AWS does not report unauthenticated requests.
      
      This field is null if no principals (IAM users, IAM roles, or root users) in the reported Organizations entity attempted to access the service within the reporting period.
    - LastAuthenticatedTime (datetime) --
      
      The date and time, in ISO 8601 date-time format, when an authenticated principal most recently attempted to access the service. AWS does not report unauthenticated requests.
      
      This field is null if no principals in the reported Organizations entity attempted to access the service within the reporting period.
    - TotalAuthenticatedEntities (integer) --
      
      The number of accounts with authenticated principals (root users, IAM users, and IAM roles) that attempted to access the service in the reporting 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.

GenerateOrganizationsAccessReport (new)

Link ¶

Generates a report for service last accessed data for AWS Organizations. You can generate a report for any entities (organization root, organizational unit, or account) or policies in your organization.

To call this operation, you must be signed in using your AWS Organizations master account credentials. You can use your long-term IAM user or root user credentials, or temporary credentials from assuming an IAM role. SCPs must be enabled for your organization root. You must have the required IAM and AWS Organizations permissions. For more information, see Refining Permissions Using Service Last Accessed Data in the IAM User Guide.

You can generate a service last accessed data report for entities by specifying only the entity's path. This data includes a list of services that are allowed by any service control policies (SCPs) that apply to the entity.

You can generate a service last accessed data report for a policy by specifying an entity's path and an optional AWS Organizations policy ID. This data includes a list of services that are allowed by the specified SCP.

For each service in both report types, the data includes the most recent account activity that the policy allows to account principals in the entity or the entity's children. For important information about the data, reporting period, permissions required, troubleshooting, and supported Regions see Reducing Permissions Using Service Last Accessed Data in the IAM User Guide.

This operation returns a JobId. Use this parameter in the GetOrganizationsAccessReport operation to check the status of the report generation. To check the status of this request, use the JobId parameter in the GetOrganizationsAccessReport operation and test the JobStatus response parameter. When the job is complete, you can retrieve the report.

To generate a service last accessed data report for entities, specify an entity path without specifying the optional AWS Organizations policy ID. The type of entity that you specify determines the data returned in the report.

Root – When you specify the organizations root as the entity, the resulting report lists all of the services allowed by SCPs that are attached to your root. For each service, the report includes data for all accounts in your organization except the master account, because the master account is not limited by SCPs.
OU – When you specify an organizational unit (OU) as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the OU and its parents. For each service, the report includes data for all accounts in the OU or its children. This data excludes the master account, because the master account is not limited by SCPs.
Master account – When you specify the master account, the resulting report lists all AWS services, because the master account is not limited by SCPs. For each service, the report includes data for only the master account.
Account – When you specify another account as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the account and its parents. For each service, the report includes data for only the specified account.

To generate a service last accessed data report for policies, specify an entity path and the optional AWS Organizations policy ID. The type of entity that you specify determines the data returned for each service.

Root – When you specify the root entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in your organization to which the SCP applies. This data excludes the master account, because the master account is not limited by SCPs. If the SCP is not attached to any entities in the organization, then the report will return a list of services with no data.
OU – When you specify an OU entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in the OU or its children to which the SCP applies. This means that other accounts outside the OU that are affected by the SCP might not be included in the data. This data excludes the master account, because the master account is not limited by SCPs. If the SCP is not attached to the OU or one of its children, the report will return a list of services with no data.
Master account – When you specify the master account, the resulting report lists all AWS services, because the master account is not limited by SCPs. If you specify a policy ID in the CLI or API, the policy is ignored. For each service, the report includes data for only the master account.
Account – When you specify another account entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for only the specified account. This means that other accounts in the organization that are affected by the SCP might not be included in the data. If the SCP is not attached to the account, the report will return a list of services with no data.

For more information about service last accessed data, see Reducing Policy Scope by Viewing User Activity in the IAM User Guide.