HumHub Documentation (unofficial)

AssumeRoleWithWebIdentityResponse extends Result
in package

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

Table of Contents

Properties

$awsClient  : AbstractApi|null
$input  : object|null
Input used to build the API request that generate this Result.
$assumedRoleUser  : AssumedRoleUser|null
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`.
$audience  : string|null
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.
$credentials  : Credentials|null
The temporary security credentials, which include an access key ID, a secret access key, and a security token.
$initialized  : bool
$packedPolicySize  : int|null
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.
$prefetchResults  : array<string|int, self>
$provider  : string|null
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.
$response  : Response
$sourceIdentity  : string|null
The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
$subjectFromWebIdentityToken  : string|null
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.

Methods

__construct()  : mixed
__destruct()  : mixed
cancel()  : void
getAssumedRoleUser()  : AssumedRoleUser|null
getAudience()  : string|null
getCredentials()  : Credentials|null
getPackedPolicySize()  : int|null
getProvider()  : string|null
getSourceIdentity()  : string|null
getSubjectFromWebIdentityToken()  : string|null
info()  : ResponseInterface, status: int}
Returns info on the current request.
resolve()  : bool
Make sure the actual request is executed.
wait()  : iterable<string|int, self>
Make sure all provided requests are executed.
initialize()  : void
populateResult()  : void
registerPrefetch()  : void
unregisterPrefetch()  : void

Properties

$input

Input used to build the API request that generate this Result.

protected object|null $input

$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`.

private AssumedRoleUser|null $assumedRoleUser

$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.

private string|null $audience

$credentials

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

private Credentials|null $credentials

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.

$initialized

private bool $initialized = false

$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.

private int|null $packedPolicySize

$prefetchResults

private array<string|int, self> $prefetchResults = []

$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.

private string|null $provider

$sourceIdentity

The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.

private string|null $sourceIdentity

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 ^1 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 ^2 in the Amazon Cognito Developer Guide. For more information about using source identity, see Monitor and control actions taken with assumed roles ^3 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: =,.@-

$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.

private string|null $subjectFromWebIdentityToken

Methods

__construct()

public __construct(Response $response[, AbstractApi|null $awsClient = null ][, object|null $request = null ]) : mixed
Parameters
$response : Response
$awsClient : AbstractApi|null = null
$request : object|null = null

__destruct()

public __destruct() : mixed

cancel()

public final cancel() : void

info()

Returns info on the current request.

public final info() : ResponseInterface, status: int}
Return values
ResponseInterface, status: int}

resolve()

Make sure the actual request is executed.

public final resolve([float|null $timeout = null ]) : bool
Parameters
$timeout : float|null = null

Duration in seconds before aborting. When null wait until the end of execution.

Tags
throws
NetworkException
throws
HttpException
Return values
bool —

whether the request is executed or not

wait()

Make sure all provided requests are executed.

public final static wait(array<string|int, self> $results[, float|null $timeout = null ][, bool $downloadBody = false ]) : iterable<string|int, self>

This only work if the http responses are produced by the same HTTP client. See https://symfony.com/doc/current/components/http_client.html#multiplexing-responses.

Parameters
$results : array<string|int, self>
$timeout : float|null = null

Duration in seconds before aborting. When null wait until the end of execution. Using 0 means non-blocking

$downloadBody : bool = false

Wait until receiving the entire response body or only the first bytes

Tags
throws
NetworkException
throws
HttpException
Return values
iterable<string|int, self>

initialize()

protected final initialize() : void

registerPrefetch()

protected final registerPrefetch(self $result) : void
Parameters
$result : self

unregisterPrefetch()

protected final unregisterPrefetch(self $result) : void
Parameters
$result : self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results