organizations_access_reports

Creates, updates, deletes, gets or lists an organizations_access_reports resource.

Overview

Name	organizations_access_reports
Type	Resource
Id	aws.iam.organizations_access_reports

Fields

The following fields are returned by SELECT queries:

get_organizations_access_report

Name	Datatype	Description
access_details	string	An object that contains details about the most recent attempt to access the service.
error_details	string	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.
is_truncated	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.
job_completion_date	string	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.
job_creation_date	string	The date and time, in ISO 8601 date-time format, when the report job was created.
job_status	string	The status of the job.
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.
number_of_services_accessible	integer	The number of services that the applicable SCPs allow account principals to access.
number_of_services_not_accessed	integer	The number of services that account principals are allowed but did not attempt to access.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_organizations_access_report	select	JobId, region	MaxItems, Marker, SortKey	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
JobId	string	The identifier of the request generated by the GenerateOrganizationsAccessReport operation.
region	string	AWS region (default: us-east-1)
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.
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.
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.

SELECT examples

get_organizations_access_report

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.

SELECT
access_details,
error_details,
is_truncated,
job_completion_date,
job_creation_date,
job_status,
marker,
number_of_services_accessible,
number_of_services_not_accessed
FROM aws.iam.organizations_access_reports
WHERE JobId = '{{ JobId }}' -- required
AND region = '{{ region }}' -- required
AND MaxItems = '{{ MaxItems }}'
AND Marker = '{{ Marker }}'
AND SortKey = '{{ SortKey }}'
;