#[non_exhaustive]pub struct AssumeRoleWithWebIdentityOutput {
pub credentials: Option<Credentials>,
pub subject_from_web_identity_token: Option<String>,
pub assumed_role_user: Option<AssumedRoleUser>,
pub packed_policy_size: Option<i32>,
pub provider: Option<String>,
pub audience: Option<String>,
pub source_identity: Option<String>,
}
Expand description
Contains the response to a successful AssumeRoleWithWebIdentity
request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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 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.
subject_from_web_identity_token: Option<String>
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.
assumed_role_user: Option<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
.
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.
provider: Option<String>
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.
audience: Option<String>
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.
source_identity: Option<String>
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: =,.@-
Implementations
sourceimpl AssumeRoleWithWebIdentityOutput
impl AssumeRoleWithWebIdentityOutput
sourcepub fn credentials(&self) -> Option<&Credentials>
pub fn credentials(&self) -> Option<&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.
sourcepub fn subject_from_web_identity_token(&self) -> Option<&str>
pub fn subject_from_web_identity_token(&self) -> Option<&str>
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.
sourcepub fn assumed_role_user(&self) -> Option<&AssumedRoleUser>
pub fn assumed_role_user(&self) -> Option<&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
.
sourcepub fn packed_policy_size(&self) -> Option<i32>
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.
sourcepub fn provider(&self) -> Option<&str>
pub fn provider(&self) -> Option<&str>
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.
sourcepub fn audience(&self) -> Option<&str>
pub fn audience(&self) -> Option<&str>
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.
sourcepub fn source_identity(&self) -> Option<&str>
pub fn source_identity(&self) -> Option<&str>
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: =,.@-
sourceimpl AssumeRoleWithWebIdentityOutput
impl AssumeRoleWithWebIdentityOutput
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture AssumeRoleWithWebIdentityOutput
Trait Implementations
sourceimpl Clone for AssumeRoleWithWebIdentityOutput
impl Clone for AssumeRoleWithWebIdentityOutput
sourcefn clone(&self) -> AssumeRoleWithWebIdentityOutput
fn clone(&self) -> AssumeRoleWithWebIdentityOutput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl PartialEq<AssumeRoleWithWebIdentityOutput> for AssumeRoleWithWebIdentityOutput
impl PartialEq<AssumeRoleWithWebIdentityOutput> for AssumeRoleWithWebIdentityOutput
sourcefn eq(&self, other: &AssumeRoleWithWebIdentityOutput) -> bool
fn eq(&self, other: &AssumeRoleWithWebIdentityOutput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &AssumeRoleWithWebIdentityOutput) -> bool
fn ne(&self, other: &AssumeRoleWithWebIdentityOutput) -> bool
This method tests for !=
.
impl StructuralPartialEq for AssumeRoleWithWebIdentityOutput
Auto Trait Implementations
impl RefUnwindSafe for AssumeRoleWithWebIdentityOutput
impl Send for AssumeRoleWithWebIdentityOutput
impl Sync for AssumeRoleWithWebIdentityOutput
impl Unpin for AssumeRoleWithWebIdentityOutput
impl UnwindSafe for AssumeRoleWithWebIdentityOutput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more