com.amazonaws.services.identitymanagement.model

Class ListVirtualMFADevicesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.ListVirtualMFADevicesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListVirtualMFADevicesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ListVirtualMFADevices operation.

Lists the virtual MFA devices under the AWS account by assignment status. If you do not specify an assignment status, the action returns a list of all virtual MFA devices. Assignment status can be Assigned , Unassigned , or Any .

You can paginate the results using the MaxItems and Marker parameters.

See Also:

AmazonIdentityManagement.listVirtualMFADevices(ListVirtualMFADevicesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListVirtualMFADevicesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListVirtualMFADevicesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAssignmentStatus() The status (unassigned or assigned) of the devices to list.
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	setAssignmentStatus(AssignmentStatusType assignmentStatus) The status (unassigned or assigned) of the devices to list.
void	setAssignmentStatus(String assignmentStatus) The status (unassigned or assigned) of the devices to list.
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.
ListVirtualMFADevicesRequest	withAssignmentStatus(AssignmentStatusType assignmentStatus) The status (unassigned or assigned) of the devices to list.
ListVirtualMFADevicesRequest	withAssignmentStatus(String assignmentStatus) The status (unassigned or assigned) of the devices to list.
ListVirtualMFADevicesRequest	withMarker(String marker) Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.
ListVirtualMFADevicesRequest	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, getCloneRoot, getCloneSource, 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

ListVirtualMFADevicesRequest

public ListVirtualMFADevicesRequest()

Method Detail

getAssignmentStatus

public String getAssignmentStatus()

The status (unassigned or assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.

Constraints:
Allowed Values: Assigned, Unassigned, Any

Returns:

The status (unassigned or assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.

See Also:

AssignmentStatusType

setAssignmentStatus

public void setAssignmentStatus(String assignmentStatus)

The status (unassigned or assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.

Constraints:
Allowed Values: Assigned, Unassigned, Any

Parameters:

assignmentStatus - The status (unassigned or assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.

See Also:

AssignmentStatusType

withAssignmentStatus

public ListVirtualMFADevicesRequest withAssignmentStatus(String assignmentStatus)

The status (unassigned or assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.

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

Constraints:
Allowed Values: Assigned, Unassigned, Any

Parameters:

assignmentStatus - The status (unassigned or assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.

Returns:

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

See Also:

AssignmentStatusType

setAssignmentStatus

public void setAssignmentStatus(AssignmentStatusType assignmentStatus)

The status (unassigned or assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.

Constraints:
Allowed Values: Assigned, Unassigned, Any

Parameters:

assignmentStatus - The status (unassigned or assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.

See Also:

AssignmentStatusType

withAssignmentStatus

public ListVirtualMFADevicesRequest withAssignmentStatus(AssignmentStatusType assignmentStatus)

The status (unassigned or assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.

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

Constraints:
Allowed Values: Assigned, Unassigned, Any

Parameters:

assignmentStatus - The status (unassigned or assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.

Returns:

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

See Also:

AssignmentStatusType

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 ListVirtualMFADevicesRequest 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 ListVirtualMFADevicesRequest 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 ListVirtualMFADevicesRequest 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()