com.amazonaws.services.ram.model

Class ListPrincipalsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ram.model.ListPrincipalsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListPrincipalsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListPrincipalsRequest()

Method Summary

Modifier and Type	Method and Description
ListPrincipalsRequest	clone()
boolean	equals(Object obj)
Integer	getMaxResults() Specifies the total number of results that you want included on each page of the response.
String	getNextToken() Specifies that you want to receive the next page of results.
List<String>	getPrincipals() Specifies that you want to list information for only the listed principals.
String	getResourceArn() Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).
String	getResourceOwner() Specifies that you want to list information for only resource shares that match the following:
List<String>	getResourceShareArns() Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).
String	getResourceType() Specifies that you want to list information for only principals associated with resource shares that include the specified resource type.
int	hashCode()
void	setMaxResults(Integer maxResults) Specifies the total number of results that you want included on each page of the response.
void	setNextToken(String nextToken) Specifies that you want to receive the next page of results.
void	setPrincipals(Collection<String> principals) Specifies that you want to list information for only the listed principals.
void	setResourceArn(String resourceArn) Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).
void	setResourceOwner(String resourceOwner) Specifies that you want to list information for only resource shares that match the following:
void	setResourceShareArns(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).
void	setResourceType(String resourceType) Specifies that you want to list information for only principals associated with resource shares that include the specified resource type.
String	toString() Returns a string representation of this object.
ListPrincipalsRequest	withMaxResults(Integer maxResults) Specifies the total number of results that you want included on each page of the response.
ListPrincipalsRequest	withNextToken(String nextToken) Specifies that you want to receive the next page of results.
ListPrincipalsRequest	withPrincipals(Collection<String> principals) Specifies that you want to list information for only the listed principals.
ListPrincipalsRequest	withPrincipals(String... principals) Specifies that you want to list information for only the listed principals.
ListPrincipalsRequest	withResourceArn(String resourceArn) Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).
ListPrincipalsRequest	withResourceOwner(ResourceOwner resourceOwner) Specifies that you want to list information for only resource shares that match the following:
ListPrincipalsRequest	withResourceOwner(String resourceOwner) Specifies that you want to list information for only resource shares that match the following:
ListPrincipalsRequest	withResourceShareArns(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).
ListPrincipalsRequest	withResourceShareArns(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).
ListPrincipalsRequest	withResourceType(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 class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListPrincipalsRequest

public ListPrincipalsRequest()

Method Detail

setResourceOwner

public void setResourceOwner(String 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

See Also:

ResourceOwner

getResourceOwner

public String getResourceOwner()

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:

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

See Also:

ResourceOwner

withResourceOwner

public ListPrincipalsRequest withResourceOwner(String 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

withResourceOwner

public ListPrincipalsRequest withResourceOwner(ResourceOwner 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

setResourceArn

public void setResourceArn(String 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).

getResourceArn

public String getResourceArn()

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

Returns:

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

withResourceArn

public ListPrincipalsRequest withResourceArn(String 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.

getPrincipals

public List<String> getPrincipals()

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:

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.

setPrincipals

public void setPrincipals(Collection<String> 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.

withPrincipals

public ListPrincipalsRequest withPrincipals(String... 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.

NOTE: This method appends the values to the existing list (if any). Use setPrincipals(java.util.Collection) or withPrincipals(java.util.Collection) if you want to override the existing values.

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.

withPrincipals

public ListPrincipalsRequest withPrincipals(Collection<String> 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.

setResourceType

public void setResourceType(String 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.

getResourceType

public String getResourceType()

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:

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.

withResourceType

public ListPrincipalsRequest withResourceType(String 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.

getResourceShareArns

public List<String> getResourceShareArns()

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

Returns:

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

setResourceShareArns

public void setResourceShareArns(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).

Parameters:

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

withResourceShareArns

public ListPrincipalsRequest withResourceShareArns(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).

NOTE: This method appends the values to the existing list (if any). Use setResourceShareArns(java.util.Collection) or withResourceShareArns(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withResourceShareArns

public ListPrincipalsRequest withResourceShareArns(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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String 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's NextToken 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 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.

getNextToken

public String getNextToken()

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:

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.

withNextToken

public ListPrincipalsRequest withNextToken(String 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's NextToken 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 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:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(Integer 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 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.

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

getMaxResults

public Integer getMaxResults()

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:

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.

withMaxResults

public ListPrincipalsRequest withMaxResults(Integer 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 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.

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, 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:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListPrincipalsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest