AssumeRoleResponse
extends Result
in package
Contains the response to a successful AssumeRole 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`.
- $credentials : Credentials|null
- The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) 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>
- $response : Response
- $sourceIdentity : string|null
- The source identity specified by the principal that is calling the `AssumeRole` operation.
Methods
- __construct() : mixed
- __destruct() : mixed
- cancel() : void
- getAssumedRoleUser() : AssumedRoleUser|null
- getCredentials() : Credentials|null
- getPackedPolicySize() : int|null
- getSourceIdentity() : 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
$awsClient
protected
AbstractApi|null
$awsClient
$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
$credentials
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) 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
= []
$response
private
Response
$response
$sourceIdentity
The source identity specified by the principal that is calling the `AssumeRole` operation.
private
string|null
$sourceIdentity
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 ^1 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: =,.@-
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
getAssumedRoleUser()
public
getAssumedRoleUser() : AssumedRoleUser|null
Return values
AssumedRoleUser|nullgetCredentials()
public
getCredentials() : Credentials|null
Return values
Credentials|nullgetPackedPolicySize()
public
getPackedPolicySize() : int|null
Return values
int|nullgetSourceIdentity()
public
getSourceIdentity() : string|null
Return values
string|nullinfo()
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
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
Return values
iterable<string|int, self>initialize()
protected
final initialize() : void
populateResult()
protected
populateResult(Response $response) : void
Parameters
- $response : Response
registerPrefetch()
protected
final registerPrefetch(self $result) : void
Parameters
- $result : self
unregisterPrefetch()
protected
final unregisterPrefetch(self $result) : void
Parameters
- $result : self