Class GetSessionTokenRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.sts.model.StsRequest
-
- software.amazon.awssdk.services.sts.model.GetSessionTokenRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetSessionTokenRequest.Builder,GetSessionTokenRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetSessionTokenRequest extends StsRequest implements ToCopyableBuilder<GetSessionTokenRequest.Builder,GetSessionTokenRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
GetSessionTokenRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetSessionTokenRequest.Builder
builder()
Integer
durationSeconds()
The duration, in seconds, that the credentials should remain valid.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
List<SdkField<?>>
sdkFields()
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 theGetSessionToken
call.GetSessionTokenRequest.Builder
toBuilder()
String
tokenCode()
The value provided by the MFA device, if MFA is required.String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
durationSeconds
public final 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 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for Amazon Web Services account owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one hour, the session for Amazon Web Services account owners defaults to one hour.
- Returns:
- The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for Amazon Web Services account owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one hour, the session for Amazon Web Services account owners defaults to one hour.
-
serialNumber
public final 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 asGAHT12345678
) or an Amazon Resource Name (ARN) for a virtual device (such asarn:aws:iam::123456789012:mfa/user
). You can find the device for an IAM user by going to the Amazon Web Services Management Console and viewing the user's security credentials.The regex used to validate 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: =,.@:/-
- Returns:
- 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 asGAHT12345678
) or an Amazon Resource Name (ARN) for a virtual device (such asarn:aws:iam::123456789012:mfa/user
). You can find the device for an IAM user by going to the Amazon Web Services Management Console and viewing the user's security credentials.The regex used to validate 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: =,.@:/-
-
tokenCode
public final 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, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives 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.
- Returns:
- 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, the user must provide a code when
requesting a set of temporary security credentials. A user who fails to provide the code receives 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.
-
toBuilder
public GetSessionTokenRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetSessionTokenRequest.Builder,GetSessionTokenRequest>
- Specified by:
toBuilder
in classStsRequest
-
builder
public static GetSessionTokenRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetSessionTokenRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-