AmazonIdentityManagementServiceClient.GetOrganizationsAccessReport Method (GetOrganizationsAccessReportRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to GetOrganizationsAccessReportAsync.

Namespace: Amazon.IdentityManagement
Assembly: AWSSDK.IdentityManagement.dll
Version: 3.x.y.z

Syntax

public virtual GetOrganizationsAccessReportResponse GetOrganizationsAccessReport(
         GetOrganizationsAccessReportRequest request
)

Parameters

request: Type: Amazon.IdentityManagement.Model.GetOrganizationsAccessReportRequest

Container for the necessary parameters to execute the GetOrganizationsAccessReport service method.

Return Value

Type: GetOrganizationsAccessReportResponse

The response from the GetOrganizationsAccessReport service method, as returned by IdentityManagementService.

Exceptions

Exception	Condition
NoSuchEntityException	The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

Examples

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

To get details from a previously generated organizational unit report


var client = new AmazonIdentityManagementServiceClient();
var response = client.GetOrganizationsAccessReport(new GetOrganizationsAccessReportRequest 
{
    JobId = "examplea-1234-b567-cde8-90fg123abcd4"
});

List<AccessDetail> accessDetails = response.AccessDetails;
bool isTruncated = response.IsTruncated;
DateTime jobCompletionDate = response.JobCompletionDate;
DateTime jobCreationDate = response.JobCreationDate;
string jobStatus = response.JobStatus;
int numberOfServicesAccessible = response.NumberOfServicesAccessible;
int numberOfServicesNotAccessed = response.NumberOfServicesNotAccessed;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonIdentityManagementServiceClient.GetOrganizationsAccessReport (GetOrganizationsAccessReportRequest)

Method