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

Inherits:

Struct

• Object
• Struct
• Aws::IAM::Types::GetOrganizationsAccessReportRequest

Includes:

Structure

Defined in:

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
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #job_id ⇒ String

  The identifier of the request generated by the GenerateOrganizationsAccessReport operation.

• #marker ⇒ String

  Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.

• #max_items ⇒ Integer

  Use this only when paginating results to indicate the maximum number of items you want in the response.

• #sort_key ⇒ String

  The key that is used to sort the results.

Instance Attribute Details

#job_id ⇒ String

The identifier of the request generated by the GenerateOrganizationsAccessReport operation.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 3686

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

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

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 3686

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

#max_items ⇒ 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.

Returns:

• (Integer)

# File 'lib/aws-sdk-iam/types.rb', line 3686

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

#sort_key ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 3686

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