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

Class: Aws::Organizations::Types::ListPoliciesForTargetRequest

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

Overview

Note:

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

{
  target_id: "PolicyTargetId", # required
  filter: "SERVICE_CONTROL_POLICY", # required, accepts SERVICE_CONTROL_POLICY
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#filterString

The type of policy that you want to include in the returned list.

Returns:

  • (String)


2086
2087
2088
2089
2090
2091
2092
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2086

class ListPoliciesForTargetRequest < Struct.new(
  :target_id,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

  • (Integer)


2086
2087
2088
2089
2090
2091
2092
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2086

class ListPoliciesForTargetRequest < Struct.new(
  :target_id,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

Returns:

  • (String)


2086
2087
2088
2089
2090
2091
2092
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2086

class ListPoliciesForTargetRequest < Struct.new(
  :target_id,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#target_idString

The unique identifier (ID) of the root, organizational unit, or account whose policies you want to list.

The regex pattern for a target ID string requires one of the following:

  • Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.

  • Account: a string that consists of exactly 12 digits.

  • Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

Returns:

  • (String)


2086
2087
2088
2089
2090
2091
2092
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2086

class ListPoliciesForTargetRequest < Struct.new(
  :target_id,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end