AssumeRoleResult (aws-android-sdk-core 2.80.0 API)

java.lang.Object
- com.amazonaws.services.securitytoken.model.AssumeRoleResult

All Implemented Interfaces:

java.io.Serializable
```
public class AssumeRoleResult
extends java.lang.Object
implements java.io.Serializable
```
Contains the response to a successful AssumeRole request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AssumeRoleResult()

Constructors
Constructor and Description
`AssumeRoleResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`AssumedRoleUser`	`getAssumedRoleUser()` 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.
`Credentials`	`getCredentials()` The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
`java.lang.Integer`	`getPackedPolicySize()` A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.
`java.lang.String`	`getSourceIdentity()` The source identity specified by the principal that is calling the `AssumeRole` operation.
`int`	`hashCode()`
`void`	`setAssumedRoleUser(AssumedRoleUser 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.
`void`	`setCredentials(Credentials credentials)` The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
`void`	`setPackedPolicySize(java.lang.Integer packedPolicySize)` A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.
`void`	`setSourceIdentity(java.lang.String sourceIdentity)` The source identity specified by the principal that is calling the `AssumeRole` operation.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AssumeRoleResult`	`withAssumedRoleUser(AssumedRoleUser 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.
`AssumeRoleResult`	`withCredentials(Credentials credentials)` The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
`AssumeRoleResult`	`withPackedPolicySize(java.lang.Integer packedPolicySize)` A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.
`AssumeRoleResult`	`withSourceIdentity(java.lang.String sourceIdentity)` The source identity specified by the principal that is calling the `AssumeRole` operation.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AssumeRoleResult
```
public AssumeRoleResult()
```
- Method Detail
  - getCredentials
```
public Credentials getCredentials()
```
    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.
    
    Returns:
    
    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.
  - setCredentials
```
public void setCredentials(Credentials 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.
    
    Parameters:
    
    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.
  - withCredentials
```
public AssumeRoleResult withCredentials(Credentials 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAssumedRoleUser
```
public AssumedRoleUser getAssumedRoleUser()
```
    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.
    
    Returns:
    
    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.
  - setAssumedRoleUser
```
public void setAssumedRoleUser(AssumedRoleUser 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.
    
    Parameters:
    
    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.
  - withAssumedRoleUser
```
public AssumeRoleResult withAssumedRoleUser(AssumedRoleUser 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPackedPolicySize
```
public java.lang.Integer getPackedPolicySize()
```
    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.
    
    Constraints:
    Range: 0 -
    
    Returns:
    
    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.
  - setPackedPolicySize
```
public void setPackedPolicySize(java.lang.Integer 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.
    
    Constraints:
    Range: 0 -
    
    Parameters:
    
    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.
  - withPackedPolicySize
```
public AssumeRoleResult withPackedPolicySize(java.lang.Integer 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSourceIdentity
```
public java.lang.String getSourceIdentity()
```
    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: =,.@-
    
    Constraints:
    Length: 2 - 64
    Pattern: [\w+=,.@-]*
    
    Returns:
    
    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: =,.@-
  - setSourceIdentity
```
public void setSourceIdentity(java.lang.String 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: =,.@-
    
    Constraints:
    Length: 2 - 64
    Pattern: [\w+=,.@-]*
    
    Parameters:
    
    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: =,.@-
  - withSourceIdentity
```
public AssumeRoleResult withSourceIdentity(java.lang.String 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: =,.@-
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 2 - 64
    Pattern: [\w+=,.@-]*
    
    Parameters:
    
    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: =,.@-
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class AssumeRoleResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AssumeRoleResult

Method Detail

getCredentials

setCredentials

withCredentials

getAssumedRoleUser

setAssumedRoleUser

withAssumedRoleUser

getPackedPolicySize

setPackedPolicySize

withPackedPolicySize

getSourceIdentity

setSourceIdentity

withSourceIdentity

toString

hashCode

equals