Class: Aws::RAM::Types::ListPrincipalsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ram/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_results ⇒ Integer

Specifies the total number of results that you want included on each page of 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 number you specify, the ‘NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service 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) 


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/aws-sdk-ram/types.rb', line 2060

class ListPrincipalsRequest < Struct.new(
  :resource_owner,
  :resource_arn,
  :principals,
  :resource_type,
  :resource_share_arns,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

Specifies that you want to receive the next page of results. Valid only if you received a ‘NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s ‘NextToken` response to request the next page of results.

Returns:

  • (String) 


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/aws-sdk-ram/types.rb', line 2060

class ListPrincipalsRequest < Struct.new(
  :resource_owner,
  :resource_arn,
  :principals,
  :resource_type,
  :resource_share_arns,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#principals ⇒ Array<String>

Specifies that you want to list information for only the listed principals.

You can include the following values:

  • An Amazon Web Services account ID, for example: ‘123456789012`

  • An [Amazon Resource Name (ARN)] of an organization in Organizations, for example: ‘organizations::123456789012:organization/o-exampleorgid`

  • An ARN of an organizational unit (OU) in Organizations, for example: ‘organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`

  • An ARN of an IAM role, for example: ‘iam::123456789012:role/rolename`

  • An ARN of an IAM user, for example: ‘iam::123456789012user/username`

<note markdown=“1”> Not all resource types can be shared with IAM roles and users. For more information, see [Sharing with IAM roles and users] in the *Resource Access Manager User Guide*.

</note>

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html [2]: docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types

Returns:

  • (Array<String>) 


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/aws-sdk-ram/types.rb', line 2060

class ListPrincipalsRequest < Struct.new(
  :resource_owner,
  :resource_arn,
  :principals,
  :resource_type,
  :resource_share_arns,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

Specifies that you want to list principal information for the resource share with the specified [Amazon Resource Name (ARN)].

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (String) 


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/aws-sdk-ram/types.rb', line 2060

class ListPrincipalsRequest < Struct.new(
  :resource_owner,
  :resource_arn,
  :principals,
  :resource_type,
  :resource_share_arns,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#resource_owner ⇒ String

Specifies that you want to list information for only resource shares that match the following:

  • SELF – principals that your account is sharing resources with

  • OTHER-ACCOUNTS – principals that are sharing resources with your account

Returns:

  • (String) 


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/aws-sdk-ram/types.rb', line 2060

class ListPrincipalsRequest < Struct.new(
  :resource_owner,
  :resource_arn,
  :principals,
  :resource_type,
  :resource_share_arns,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#resource_share_arns ⇒ Array<String>

Specifies that you want to list information for only principals associated with the resource shares specified by a list the [Amazon Resource Names (ARNs)].

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (Array<String>) 


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/aws-sdk-ram/types.rb', line 2060

class ListPrincipalsRequest < Struct.new(
  :resource_owner,
  :resource_arn,
  :principals,
  :resource_type,
  :resource_share_arns,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

Specifies that you want to list information for only principals associated with resource shares that include the specified resource type.

For a list of valid values, query the ListResourceTypes operation.

Returns:

  • (String) 


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/aws-sdk-ram/types.rb', line 2060

class ListPrincipalsRequest < Struct.new(
  :resource_owner,
  :resource_arn,
  :principals,
  :resource_type,
  :resource_share_arns,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end