TokenRefreshRequiredException
extends S3Exception
in package
The provided token must be refreshed.
Table of Contents
Properties
- $exceptionCode : string
- $exceptionType : string
- $request : RequestInterface
- $requestId : string
- $response : Response
Methods
- __toString() : string
- Cast to a string
- getAwsErrorCode() : string|null
- Get the AWS error code.
- getAwsErrorType() : string|null
- Get the AWS error type.
- getAwsRequestId() : string|null
- Get the request ID of the error. This value is only present if a response was received, and is not present in the event of a networking error.
- getExceptionCode() : string|null
- Get the exception code
- getExceptionType() : string|null
- Get the exception type (one of client or server)
- getRequest() : RequestInterface|null
- Get the associated request object
- getRequestId() : string|null
- Get the Request ID
- getResponse() : Response|null
- Get the associated response object
- getStatusCode() : int|null
- Get the status code of the response
- setExceptionCode() : mixed
- Set the exception code
- setExceptionType() : mixed
- Set the exception type
- setRequest() : mixed
- Set the associated request
- setRequestId() : mixed
- Set the request ID
- setResponse() : mixed
- Set the associated response
Properties
$exceptionCode
protected
string
$exceptionCode
Exception code
$exceptionType
protected
string
$exceptionType
Exception type (client / server)
$request
protected
RequestInterface
$request
Request
$requestId
protected
string
$requestId
Request ID
$response
protected
Response
$response
Response
Methods
__toString()
Cast to a string
public
__toString() : string
Return values
stringgetAwsErrorCode()
Get the AWS error code.
public
getAwsErrorCode() : string|null
Same as getExceptionCode() method, but matches the interface for SDKv3.
Return values
string|null —Returns null if no response was received
getAwsErrorType()
Get the AWS error type.
public
getAwsErrorType() : string|null
Same as getExceptionType() method, but matches the interface for SDKv3.
Return values
string|null —Returns null if no response was received
getAwsRequestId()
Get the request ID of the error. This value is only present if a response was received, and is not present in the event of a networking error.
public
getAwsRequestId() : string|null
Same as getRequestId() method, but matches the interface for SDKv3.
Return values
string|null —Returns null if no response was received
getExceptionCode()
Get the exception code
public
getExceptionCode() : string|null
Return values
string|nullgetExceptionType()
Get the exception type (one of client or server)
public
getExceptionType() : string|null
Return values
string|nullgetRequest()
Get the associated request object
public
getRequest() : RequestInterface|null
Return values
RequestInterface|nullgetRequestId()
Get the Request ID
public
getRequestId() : string|null
Return values
string|nullgetResponse()
Get the associated response object
public
getResponse() : Response|null
Return values
Response|nullgetStatusCode()
Get the status code of the response
public
getStatusCode() : int|null
Return values
int|nullsetExceptionCode()
Set the exception code
public
setExceptionCode(string $code) : mixed
Parameters
- $code : string
-
Exception code
setExceptionType()
Set the exception type
public
setExceptionType(string $type) : mixed
Parameters
- $type : string
-
Exception type
setRequest()
Set the associated request
public
setRequest(RequestInterface $request) : mixed
Parameters
- $request : RequestInterface
setRequestId()
Set the request ID
public
setRequestId(string $id) : mixed
Parameters
- $id : string
-
Request ID
setResponse()
Set the associated response
public
setResponse(Response $response) : mixed
Parameters
- $response : Response
-
Response