@Generated(value="software.amazon.awssdk:codegen") public final class GetSessionTokenRequest extends StsRequest implements ToCopyableBuilder<GetSessionTokenRequest.Builder,GetSessionTokenRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
GetSessionTokenRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static GetSessionTokenRequest.Builder |
builder() |
Integer |
durationSeconds()
The duration, in seconds, that the credentials should remain valid.
|
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() |
static Class<? extends GetSessionTokenRequest.Builder> |
serializableBuilderClass() |
String |
serialNumber()
The identification number of the MFA device that is associated with the IAM user who is making the
GetSessionToken call. |
GetSessionTokenRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
tokenCode()
The value provided by the MFA device, if MFA is required.
|
String |
toString() |
overrideConfiguration
copy
public Integer durationSeconds()
The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.
public String serialNumber()
The identification number of the MFA device that is associated with the IAM user who is making the
GetSessionToken
call. Specify this value if the IAM user has a policy that requires MFA
authentication. The value is either the serial number for a hardware device (such as GAHT12345678
)
or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user
).
You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security
credentials.
The regex used to validated this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
GetSessionToken
call. Specify this value if the IAM user has a policy that requires MFA
authentication. The value is either the serial number for a hardware device (such as
GAHT12345678
) or an Amazon Resource Name (ARN) for a virtual device (such as
arn:aws:iam::123456789012:mfa/user
). You can find the device for an IAM user by going to the
AWS Management Console and viewing the user's security credentials.
The regex used to validated this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
public String tokenCode()
The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, and the user does not provide a code when requesting a set of temporary security credentials, the user will receive an "access denied" response when requesting resources that require MFA authentication.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
public GetSessionTokenRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetSessionTokenRequest.Builder,GetSessionTokenRequest>
toBuilder
in class StsRequest
public static GetSessionTokenRequest.Builder builder()
public static Class<? extends GetSessionTokenRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.