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

Class: Aws::IAM::Types::GetOrganizationsAccessReportRequest

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 GetOrganizationsAccessReportRequest data as a hash:

{
  job_id: "jobIDType", # required
  max_items: 1,
  marker: "markerType",
  sort_key: "SERVICE_NAMESPACE_ASCENDING", # accepts SERVICE_NAMESPACE_ASCENDING, SERVICE_NAMESPACE_DESCENDING, LAST_AUTHENTICATED_TIME_ASCENDING, LAST_AUTHENTICATED_TIME_DESCENDING
}

Instance Attribute Summary collapse

Instance Attribute Details

#job_idString

The identifier of the request generated by the GenerateOrganizationsAccessReport operation.

Returns:

  • (String)


3663
3664
3665
3666
3667
3668
3669
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 3663

class GetOrganizationsAccessReportRequest < Struct.new(
  :job_id,
  :max_items,
  :marker,
  :sort_key)
  include Aws::Structure
end

#markerString

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.

Returns:

  • (String)


3663
3664
3665
3666
3667
3668
3669
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 3663

class GetOrganizationsAccessReportRequest < Struct.new(
  :job_id,
  :max_items,
  :marker,
  :sort_key)
  include Aws::Structure
end

#max_itemsInteger

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.

Returns:

  • (Integer)


3663
3664
3665
3666
3667
3668
3669
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 3663

class GetOrganizationsAccessReportRequest < Struct.new(
  :job_id,
  :max_items,
  :marker,
  :sort_key)
  include Aws::Structure
end

#sort_keyString

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.

Returns:

  • (String)


3663
3664
3665
3666
3667
3668
3669
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 3663

class GetOrganizationsAccessReportRequest < Struct.new(
  :job_id,
  :max_items,
  :marker,
  :sort_key)
  include Aws::Structure
end