You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::IAM::Types::GenerateOrganizationsAccessReportRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb

Overview

Note:

When making an API call, you may pass GenerateOrganizationsAccessReportRequest data as a hash:

{
  entity_path: "organizationsEntityPathType", # required
  organizations_policy_id: "organizationsPolicyIdType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#entity_pathString

The path of the AWS Organizations entity (root, OU, or account). You can build an entity path using the known structure of your organization. For example, assume that your account ID is 123456789012 and its parent OU ID is ou-rge0-awsabcde. The organization root ID is r-f6g7h8i9j0example and your organization ID is o-a1b2c3d4e5. Your entity path is o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012.

Returns:

  • (String)


2965
2966
2967
2968
2969
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2965

class GenerateOrganizationsAccessReportRequest < Struct.new(
  :entity_path,
  :organizations_policy_id)
  include Aws::Structure
end

#organizations_policy_idString

The identifier of the AWS Organizations service control policy (SCP). This parameter is optional.

This ID is used to generate information about when an account principal that is limited by the SCP attempted to access an AWS service.

Returns:

  • (String)


2965
2966
2967
2968
2969
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2965

class GenerateOrganizationsAccessReportRequest < Struct.new(
  :entity_path,
  :organizations_policy_id)
  include Aws::Structure
end