AssumeRoleResponse Class | AWS SDK for .NET V3

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

Inheritance Hierarchy

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

Namespace: Amazon.SecurityToken.Model
Assembly: AWSSDK.SecurityToken.dll
Version: 3.x.y.z

Syntax

public class AssumeRoleResponse : AmazonWebServiceResponse

The AssumeRoleResponse type exposes the following members

Constructors

	Name	Description
	AssumeRoleResponse()

Properties

Name	Type	Description
AssumedRoleUser	Amazon.SecurityToken.Model.AssumedRoleUser	Gets and sets the property AssumedRoleUser. The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the `RoleSessionName` that you specified when you called `AssumeRole`.
ContentLength	System.Int64	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
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. 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.
HttpStatusCode	System.Net.HttpStatusCode	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
PackedPolicySize	System.Int32	Gets and sets the property PackedPolicySize. 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.
ResponseMetadata	Amazon.Runtime.ResponseMetadata	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
SourceIdentity	System.String	Gets and sets the property SourceIdentity. The source identity specified by the principal that is calling the `AssumeRole` operation. You can require users to specify a source identity when they assume a role. You do this by using the `sts:SourceIdentity` condition key in a role trust policy. You can use source identity information in CloudTrail logs to determine who took actions with a role. You can use the `aws:SourceIdentity` condition key to further control access to Amazon Web Services resources based on the value of source identity. 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: =,.@-

Examples

To assume a role


var client = new AmazonSecurityTokenServiceClient();
var response = client.AssumeRole(new AssumeRoleRequest 
{
    ExternalId = "123ABC",
    Policy = "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Stmt1\",\"Effect\":\"Allow\",\"Action\":\"s3:ListAllMyBuckets\",\"Resource\":\"*\"}]}",
    RoleArn = "arn:aws:iam::123456789012:role/demo",
    RoleSessionName = "testAssumeRoleSession",
    Tags = new List<Tag> {
        new Tag {
            Key = "Project",
            Value = "Unicorn"
        },
        new Tag {
            Key = "Team",
            Value = "Automation"
        },
        new Tag {
            Key = "Cost-Center",
            Value = "12345"
        }
    },
    TransitiveTagKeys = new List<string> {
        "Project",
        "Cost-Center"
    }
});

AssumedRoleUser assumedRoleUser = response.AssumedRoleUser;
Credentials credentials = response.Credentials;
int packedPolicySize = response.PackedPolicySize;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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