// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct GetSessionTokenInput {
/// <p>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.</p>
pub duration_seconds: ::std::option::Option<i32>,
/// <p>The identification number of the MFA device that is associated with the IAM user who is making the <code>GetSessionToken</code> 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 <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). 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.</p>
/// <p>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: =,.@:/-</p>
pub serial_number: ::std::option::Option<::std::string::String>,
/// <p>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.</p>
/// <p>The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.</p>
pub token_code: ::std::option::Option<::std::string::String>,
/// The minimum size, in bytes, of the session token that STS issues for the request. STS increases the session token to at least this size, regardless of its actual content. The value must not exceed 4,096 bytes. When set to 0 or not specified, the session token size is unchanged.
pub minimum_session_token_size: ::std::option::Option<i32>,
}
impl GetSessionTokenInput {
/// <p>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.</p>
pub fn duration_seconds(&self) -> ::std::option::Option<i32> {
self.duration_seconds
}
/// <p>The identification number of the MFA device that is associated with the IAM user who is making the <code>GetSessionToken</code> 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 <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). 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.</p>
/// <p>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: =,.@:/-</p>
pub fn serial_number(&self) -> ::std::option::Option<&str> {
self.serial_number.as_deref()
}
/// <p>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.</p>
/// <p>The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.</p>
pub fn token_code(&self) -> ::std::option::Option<&str> {
self.token_code.as_deref()
}
/// The minimum size, in bytes, of the session token that STS issues for the request. STS increases the session token to at least this size, regardless of its actual content. The value must not exceed 4,096 bytes. When set to 0 or not specified, the session token size is unchanged.
pub fn minimum_session_token_size(&self) -> ::std::option::Option<i32> {
self.minimum_session_token_size
}
}
impl GetSessionTokenInput {
/// Creates a new builder-style object to manufacture [`GetSessionTokenInput`](crate::operation::get_session_token::GetSessionTokenInput).
pub fn builder() -> crate::operation::get_session_token::builders::GetSessionTokenInputBuilder {
crate::operation::get_session_token::builders::GetSessionTokenInputBuilder::default()
}
}
/// A builder for [`GetSessionTokenInput`](crate::operation::get_session_token::GetSessionTokenInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetSessionTokenInputBuilder {
pub(crate) duration_seconds: ::std::option::Option<i32>,
pub(crate) serial_number: ::std::option::Option<::std::string::String>,
pub(crate) token_code: ::std::option::Option<::std::string::String>,
pub(crate) minimum_session_token_size: ::std::option::Option<i32>,
}
impl GetSessionTokenInputBuilder {
/// <p>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.</p>
pub fn duration_seconds(mut self, input: i32) -> Self {
self.duration_seconds = ::std::option::Option::Some(input);
self
}
/// <p>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.</p>
pub fn set_duration_seconds(mut self, input: ::std::option::Option<i32>) -> Self {
self.duration_seconds = input;
self
}
/// <p>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.</p>
pub fn get_duration_seconds(&self) -> &::std::option::Option<i32> {
&self.duration_seconds
}
/// <p>The identification number of the MFA device that is associated with the IAM user who is making the <code>GetSessionToken</code> 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 <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). 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.</p>
/// <p>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: =,.@:/-</p>
pub fn serial_number(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.serial_number = ::std::option::Option::Some(input.into());
self
}
/// <p>The identification number of the MFA device that is associated with the IAM user who is making the <code>GetSessionToken</code> 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 <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). 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.</p>
/// <p>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: =,.@:/-</p>
pub fn set_serial_number(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.serial_number = input;
self
}
/// <p>The identification number of the MFA device that is associated with the IAM user who is making the <code>GetSessionToken</code> 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 <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). 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.</p>
/// <p>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: =,.@:/-</p>
pub fn get_serial_number(&self) -> &::std::option::Option<::std::string::String> {
&self.serial_number
}
/// <p>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.</p>
/// <p>The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.</p>
pub fn token_code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.token_code = ::std::option::Option::Some(input.into());
self
}
/// <p>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.</p>
/// <p>The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.</p>
pub fn set_token_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.token_code = input;
self
}
/// <p>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.</p>
/// <p>The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.</p>
pub fn get_token_code(&self) -> &::std::option::Option<::std::string::String> {
&self.token_code
}
/// The minimum size, in bytes, of the session token that STS issues for the request. STS increases the session token to at least this size, regardless of its actual content. The value must not exceed 4,096 bytes. When set to 0 or not specified, the session token size is unchanged.
pub fn minimum_session_token_size(mut self, input: i32) -> Self {
self.minimum_session_token_size = ::std::option::Option::Some(input);
self
}
/// The minimum size, in bytes, of the session token that STS issues for the request. STS increases the session token to at least this size, regardless of its actual content. The value must not exceed 4,096 bytes. When set to 0 or not specified, the session token size is unchanged.
pub fn set_minimum_session_token_size(mut self, input: ::std::option::Option<i32>) -> Self {
self.minimum_session_token_size = input;
self
}
/// The minimum size, in bytes, of the session token that STS issues for the request. STS increases the session token to at least this size, regardless of its actual content. The value must not exceed 4,096 bytes. When set to 0 or not specified, the session token size is unchanged.
pub fn get_minimum_session_token_size(&self) -> &::std::option::Option<i32> {
&self.minimum_session_token_size
}
/// Consumes the builder and constructs a [`GetSessionTokenInput`](crate::operation::get_session_token::GetSessionTokenInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::get_session_token::GetSessionTokenInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::get_session_token::GetSessionTokenInput {
duration_seconds: self.duration_seconds,
serial_number: self.serial_number,
token_code: self.token_code,
minimum_session_token_size: self.minimum_session_token_size,
})
}
}