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

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

All Implemented Interfaces:

java.io.Serializable
```
public class AssumeRoleWithWebIdentityResult
extends java.lang.Object
implements java.io.Serializable
```
Contains the response to a successful AssumeRoleWithWebIdentity 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

AssumeRoleWithWebIdentityResult()

Constructors
Constructor and Description
`AssumeRoleWithWebIdentityResult()`

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.
`java.lang.String`	`getAudience()` The intended audience (also known as client ID) of the web identity token.
`Credentials`	`getCredentials()` The temporary security credentials, which include an access key ID, a secret access key, and a security 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`	`getProvider()` The issuing authority of the web identity token presented.
`java.lang.String`	`getSourceIdentity()` The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
`java.lang.String`	`getSubjectFromWebIdentityToken()` The unique user identifier that is returned by the identity provider.
`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`	`setAudience(java.lang.String audience)` The intended audience (also known as client ID) of the web identity token.
`void`	`setCredentials(Credentials credentials)` The temporary security credentials, which include an access key ID, a secret access key, and a security 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`	`setProvider(java.lang.String provider)` The issuing authority of the web identity token presented.
`void`	`setSourceIdentity(java.lang.String sourceIdentity)` The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
`void`	`setSubjectFromWebIdentityToken(java.lang.String subjectFromWebIdentityToken)` The unique user identifier that is returned by the identity provider.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AssumeRoleWithWebIdentityResult`	`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.
`AssumeRoleWithWebIdentityResult`	`withAudience(java.lang.String audience)` The intended audience (also known as client ID) of the web identity token.
`AssumeRoleWithWebIdentityResult`	`withCredentials(Credentials credentials)` The temporary security credentials, which include an access key ID, a secret access key, and a security token.
`AssumeRoleWithWebIdentityResult`	`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.
`AssumeRoleWithWebIdentityResult`	`withProvider(java.lang.String provider)` The issuing authority of the web identity token presented.
`AssumeRoleWithWebIdentityResult`	`withSourceIdentity(java.lang.String sourceIdentity)` The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
`AssumeRoleWithWebIdentityResult`	`withSubjectFromWebIdentityToken(java.lang.String subjectFromWebIdentityToken)` The unique user identifier that is returned by the identity provider.

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

- Constructor Detail
  - AssumeRoleWithWebIdentityResult
```
public AssumeRoleWithWebIdentityResult()
```
- Method Detail
  - getCredentials
```
public Credentials getCredentials()
```
    The temporary security credentials, which include an access key ID, a secret access key, and a security 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 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 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 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 AssumeRoleWithWebIdentityResult withCredentials(Credentials credentials)
```
    The temporary security credentials, which include an access key ID, a secret access key, and a security 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 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.
  - getSubjectFromWebIdentityToken
```
public java.lang.String getSubjectFromWebIdentityToken()
```
    The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.
    
    Constraints:
    Length: 6 - 255
    
    Returns:
    
    The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.
  - setSubjectFromWebIdentityToken
```
public void setSubjectFromWebIdentityToken(java.lang.String subjectFromWebIdentityToken)
```
    The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.
    
    Constraints:
    Length: 6 - 255
    
    Parameters:
    
    subjectFromWebIdentityToken -
    The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.
  - withSubjectFromWebIdentityToken
```
public AssumeRoleWithWebIdentityResult withSubjectFromWebIdentityToken(java.lang.String subjectFromWebIdentityToken)
```
    The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 6 - 255
    
    Parameters:
    
    subjectFromWebIdentityToken -
    The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.
    
    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 AssumeRoleWithWebIdentityResult 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 AssumeRoleWithWebIdentityResult 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.
  - getProvider
```
public java.lang.String getProvider()
```
    The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.
    
    Returns:
    
    The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.
  - setProvider
```
public void setProvider(java.lang.String provider)
```
    The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.
    
    Parameters:
    
    provider -
    The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.
  - withProvider
```
public AssumeRoleWithWebIdentityResult withProvider(java.lang.String provider)
```
    The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    provider -
    The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAudience
```
public java.lang.String getAudience()
```
    The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
    
    Returns:
    
    The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
  - setAudience
```
public void setAudience(java.lang.String audience)
```
    The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
    
    Parameters:
    
    audience -
    The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
  - withAudience
```
public AssumeRoleWithWebIdentityResult withAudience(java.lang.String audience)
```
    The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    audience -
    The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSourceIdentity
```
public java.lang.String getSourceIdentity()
```
    The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
    
    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 identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithWebIdentity. You do this by adding a claim to the JSON web token. To learn more about OIDC tokens and claims, see Using Tokens with User Pools in the Amazon Cognito Developer Guide. 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 value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
    
    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 identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithWebIdentity. You do this by adding a claim to the JSON web token. To learn more about OIDC tokens and claims, see Using Tokens with User Pools in the Amazon Cognito Developer Guide. 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 value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
    
    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 identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithWebIdentity. You do this by adding a claim to the JSON web token. To learn more about OIDC tokens and claims, see Using Tokens with User Pools in the Amazon Cognito Developer Guide. 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 value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
    
    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 identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithWebIdentity. You do this by adding a claim to the JSON web token. To learn more about OIDC tokens and claims, see Using Tokens with User Pools in the Amazon Cognito Developer Guide. 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 AssumeRoleWithWebIdentityResult withSourceIdentity(java.lang.String sourceIdentity)
```
    The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
    
    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 identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithWebIdentity. You do this by adding a claim to the JSON web token. To learn more about OIDC tokens and claims, see Using Tokens with User Pools in the Amazon Cognito Developer Guide. 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 value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
    
    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 identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithWebIdentity. You do this by adding a claim to the JSON web token. To learn more about OIDC tokens and claims, see Using Tokens with User Pools in the Amazon Cognito Developer Guide. 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 AssumeRoleWithWebIdentityResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AssumeRoleWithWebIdentityResult

Method Detail

getCredentials

setCredentials

withCredentials

getSubjectFromWebIdentityToken

setSubjectFromWebIdentityToken

withSubjectFromWebIdentityToken

getAssumedRoleUser

setAssumedRoleUser

withAssumedRoleUser

getPackedPolicySize

setPackedPolicySize

withPackedPolicySize

getProvider

setProvider

withProvider

getAudience

setAudience

withAudience

getSourceIdentity

setSourceIdentity

withSourceIdentity

toString

hashCode

equals