software.amazon.awssdk.services.iam.model

Class ListVirtualMFADevicesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iam.model.IAMRequest

software.amazon.awssdk.services.iam.model.ListVirtualMFADevicesRequest

All Implemented Interfaces:

ToCopyableBuilder<ListVirtualMFADevicesRequest.Builder,ListVirtualMFADevicesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class ListVirtualMFADevicesRequest
extends IAMRequest
implements ToCopyableBuilder<ListVirtualMFADevicesRequest.Builder,ListVirtualMFADevicesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListVirtualMFADevicesRequest.Builder

Method Summary

Modifier and Type	Method and Description
AssignmentStatusType	assignmentStatus() The status (Unassigned or Assigned) of the devices to list.
String	assignmentStatusAsString() The status (Unassigned or Assigned) of the devices to list.
static ListVirtualMFADevicesRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	marker() Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.
Integer	maxItems() (Optional) Use this only when paginating results to indicate the maximum number of items you want in the response.
static Class<? extends ListVirtualMFADevicesRequest.Builder>	serializableBuilderClass()
ListVirtualMFADevicesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

assignmentStatus

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

If the service returns an enum value that is not available in the current SDK version, assignmentStatus will return AssignmentStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assignmentStatusAsString().

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

assignmentStatusAsString

public String assignmentStatusAsString()

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.

If the service returns an enum value that is not available in the current SDK version, assignmentStatus will return AssignmentStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assignmentStatusAsString().

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

marker

public 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 that you received to indicate where the next call should start.

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 that you received to indicate where the next call should start.

maxItems

public Integer maxItems()

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

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

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

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

toBuilder

public ListVirtualMFADevicesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListVirtualMFADevicesRequest.Builder,ListVirtualMFADevicesRequest>

Specified by:

toBuilder in class IAMRequest

Returns:

a builder for type T

builder

public static ListVirtualMFADevicesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListVirtualMFADevicesRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value