AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
 
Contains the response to a successful AssumeRoleWithSAML request, including temporary AWS credentials that can be used to make AWS requests.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.SecurityToken.Model.AssumeRoleWithSAMLResult

Namespace: Amazon.SecurityToken.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class AssumeRoleWithSAMLResult : AmazonWebServiceResponse

The AssumeRoleWithSAMLResult type exposes the following members

Constructors

NameDescription
Public Method AssumeRoleWithSAMLResult()

Properties

NameTypeDescription
Public Property AssumedRoleUser Amazon.SecurityToken.Model.AssumedRoleUser Gets and sets the property AssumedRoleUser.
Public Property Audience System.String Gets and sets the property Audience.

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

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Credentials Amazon.SecurityToken.Model.Credentials Gets and sets the property Credentials.

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

Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Issuer System.String Gets and sets the property Issuer.

The value of the Issuer element of the SAML assertion.

Public Property NameQualifier System.String Gets and sets the property NameQualifier.

A hash value based on the concatenation of the Issuer response value, the AWS account ID, and 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 federated user.

The following pseudocode shows how the hash value is calculated:

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

Public Property PackedPolicySize System.Int32 Gets and sets the property PackedPolicySize.

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Subject System.String Gets and sets the property Subject.

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

Public Property SubjectType System.String Gets and sets the property SubjectType.

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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8