com.amazonaws.services.identitymanagement.model

Class GetGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.GetGroupRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class GetGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the GetGroup operation.

Returns a list of users that are in the specified group. You can paginate the results using the MaxItems and Marker parameters.

See Also:

AmazonIdentityManagement.getGroup(GetGroupRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetGroupRequest() Default constructor for a new GetGroupRequest object.
GetGroupRequest(String groupName) Constructs a new GetGroupRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
GetGroupRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getGroupName() The name of the group.
String	getMarker() Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.
Integer	getMaxItems() Use this only when paginating results to indicate the maximum number of items you want in the response.
int	hashCode()
void	setGroupName(String groupName) The name of the group.
void	setMarker(String marker) Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.
void	setMaxItems(Integer maxItems) Use this only when paginating results to indicate the maximum number of items you want in the response.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetGroupRequest	withGroupName(String groupName) The name of the group.
GetGroupRequest	withMarker(String marker) Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.
GetGroupRequest	withMaxItems(Integer maxItems) Use this only when paginating results to indicate the maximum number of items you want in the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

GetGroupRequest

public GetGroupRequest()

Default constructor for a new GetGroupRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

GetGroupRequest

public GetGroupRequest(String groupName)

Constructs a new GetGroupRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

groupName - The name of the group.

Method Detail

getGroupName

public String getGroupName()

The name of the group.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Returns:

The name of the group.

setGroupName

public void setGroupName(String groupName)

The name of the group.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Parameters:

groupName - The name of the group.

withGroupName

public GetGroupRequest withGroupName(String groupName)

The name of the group.

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

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Parameters:

groupName - The name of the group.

Returns:

A reference to this updated object so that method calls can be chained together.

getMarker

public String getMarker()

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 you received to inform the next call about where to start.

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+

Returns:

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 you received to inform the next call about where to start.

setMarker

public void setMarker(String marker)

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 you received to inform the next call about where to start.

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+

Parameters:

marker - 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 you received to inform the next call about where to start.

withMarker

public GetGroupRequest withMarker(String marker)

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 you received to inform the next call about where to start.

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

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+

Parameters:

marker - 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 you received to inform the next call about where to start.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxItems

public Integer getMaxItems()

Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the IsTruncated response element is true.

This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the 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.

Constraints:
Range: 1 - 1000

Returns:

Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the IsTruncated response element is true.

This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the 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.

setMaxItems

public void setMaxItems(Integer maxItems)

Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the IsTruncated response element is true.

This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the 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.

Constraints:
Range: 1 - 1000

Parameters:

maxItems - Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the IsTruncated response element is true.

This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the 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.

withMaxItems

public GetGroupRequest withMaxItems(Integer maxItems)

Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the IsTruncated response element is true.

This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the 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 a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 1000

Parameters:

maxItems - Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the IsTruncated response element is true.

This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the 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:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public GetGroupRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()