Struct AssumeRoleWithSamlOutput

#[non_exhaustive]
pub struct AssumeRoleWithSamlOutput {
    pub credentials: Option<Credentials>,
    pub assumed_role_user: Option<AssumedRoleUser>,
    pub packed_policy_size: Option<i32>,
    pub subject: Option<String>,
    pub subject_type: Option<String>,
    pub issuer: Option<String>,
    pub audience: Option<String>,
    pub name_qualifier: Option<String>,
    pub source_identity: Option<String>,
    /* private fields */
}

Contains the response to a successful AssumeRoleWithSAML request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

credentials: Option<Credentials>

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

assumed_role_user: Option<AssumedRoleUser>

The identifiers for the temporary security credentials that the operation returns.

packed_policy_size: Option<i32>

A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.

subject: Option<String>

The value of the NameID element in the Subject element of the SAML assertion.

subject_type: Option<String>

The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion. Typical examples of the format are transient or persistent.

If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If the format includes any other prefix, the format is returned with no modifications.

issuer: Option<String>

The value of the Issuer element of the SAML assertion.

audience: Option<String>

The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.

name_qualifier: Option<String>

A hash value based on the concatenation of the following:

• The Issuer response value.

• The Amazon Web Services account ID.

• The friendly name (the last part of the ARN) of the SAML provider in IAM.

The combination of NameQualifier and Subject can be used to uniquely identify a user.

The following pseudocode shows how the hash value is calculated:

BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )

source_identity: Option<String>

The value in the SourceIdentity attribute in the SAML assertion.

You can require users to set a source identity value when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. That way, actions that are taken with the role are associated with that user. After the source identity is set, the value cannot be changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your SAML identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithSAML. You do this by adding an attribute to the SAML assertion. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.

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: =,.@-

Implementations

impl AssumeRoleWithSamlOutput

pub fn credentials(&self) -> Option<&Credentials>

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

pub fn assumed_role_user(&self) -> Option<&AssumedRoleUser>

The identifiers for the temporary security credentials that the operation returns.

pub fn packed_policy_size(&self) -> Option<i32>

A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.

pub fn subject(&self) -> Option<&str>

The value of the NameID element in the Subject element of the SAML assertion.

pub fn subject_type(&self) -> Option<&str>

The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion. Typical examples of the format are transient or persistent.

If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If the format includes any other prefix, the format is returned with no modifications.

pub fn issuer(&self) -> Option<&str>

The value of the Issuer element of the SAML assertion.

pub fn audience(&self) -> Option<&str>

The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.

pub fn name_qualifier(&self) -> Option<&str>

A hash value based on the concatenation of the following:

• The Issuer response value.

• The Amazon Web Services account ID.

• The friendly name (the last part of the ARN) of the SAML provider in IAM.

The combination of NameQualifier and Subject can be used to uniquely identify a user.

The following pseudocode shows how the hash value is calculated:

BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )

pub fn source_identity(&self) -> Option<&str>

The value in the SourceIdentity attribute in the SAML assertion.

You can require users to set a source identity value when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. That way, actions that are taken with the role are associated with that user. After the source identity is set, the value cannot be changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your SAML identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithSAML. You do this by adding an attribute to the SAML assertion. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.

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: =,.@-

impl AssumeRoleWithSamlOutput

pub fn builder() -> AssumeRoleWithSamlOutputBuilder

Creates a new builder-style object to manufacture AssumeRoleWithSamlOutput.

Trait Implementations

impl Clone for AssumeRoleWithSamlOutput

fn clone(&self) -> AssumeRoleWithSamlOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AssumeRoleWithSamlOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AssumeRoleWithSamlOutput

fn eq(&self, other: &AssumeRoleWithSamlOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for AssumeRoleWithSamlOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for AssumeRoleWithSamlOutput