Interface ListPrincipalsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListPrincipalsRequest.Builder,
,ListPrincipalsRequest> RamRequest.Builder
,SdkBuilder<ListPrincipalsRequest.Builder,
,ListPrincipalsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListPrincipalsRequest
-
Method Summary
Modifier and TypeMethodDescriptionmaxResults
(Integer maxResults) Specifies the total number of results that you want included on each page of the response.Specifies that you want to receive the next page of results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.principals
(String... principals) Specifies that you want to list information for only the listed principals.principals
(Collection<String> principals) Specifies that you want to list information for only the listed principals.resourceArn
(String resourceArn) Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).resourceOwner
(String resourceOwner) Specifies that you want to list information for only resource shares that match the following:resourceOwner
(ResourceOwner resourceOwner) Specifies that you want to list information for only resource shares that match the following:resourceShareArns
(String... resourceShareArns) Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).resourceShareArns
(Collection<String> resourceShareArns) Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).resourceType
(String resourceType) Specifies that you want to list information for only principals associated with resource shares that include the specified resource type.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.ram.model.RamRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
resourceOwner
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
- Parameters:
resourceOwner
- 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
resourceOwner
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
- Parameters:
resourceOwner
- 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
resourceArn
Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).
- Parameters:
resourceArn
- Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
principals
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
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.
- Parameters:
principals
- 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
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
principals
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
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.
- Parameters:
principals
- 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
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
resourceType
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.
- Parameters:
resourceType
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
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'sNextToken
response to request the next page of results.- Parameters:
nextToken
- Specifies that you want to receive the next page of results. Valid only if you received aNextToken
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'sNextToken
response to request the next page of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
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 theNextToken
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 checkNextToken
after every operation to ensure that you receive all of the results.- Parameters:
maxResults
- 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, theNextToken
response element is returned with a value (not null). Include the specified value as theNextToken
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 checkNextToken
after every operation to ensure that you receive all of the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListPrincipalsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListPrincipalsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-