PinpointEmailException
extends AwsException
in package
Represents an error interacting with the Amazon Pinpoint Email Service service.
Table of Contents
Methods
- __construct() : mixed
- __toString() : mixed
- appendMonitoringEvent() : mixed
- Append a client-side monitoring event to this object's event list
- count() : int
- get() : mixed
- getAwsErrorCode() : string|null
- Get the AWS error code.
- getAwsErrorMessage() : string|null
- Get the concise error message if any.
- getAwsErrorShape() : Shape|null
- Get the AWS error shape.
- 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.
- getCommand() : CommandInterface
- Get the command that was executed.
- getIterator() : Traversable
- getMonitoringEvents() : array<string|int, mixed>
- Get client-side monitoring events attached to this object. Each event is represented as an associative array within the returned array.
- getRequest() : RequestInterface|null
- Get the sent HTTP request if any.
- getResponse() : ResponseInterface|null
- Get the received HTTP response if any.
- getResult() : ResultInterface|null
- Get the result of the exception if available
- getStatusCode() : int|null
- If available, gets the HTTP status code of the corresponding response
- getTransferInfo() : mixed|null|array<string|int, mixed>
- Get all transfer information as an associative array if no $name argument is supplied, or gets a specific transfer statistic if a $name attribute is supplied (e.g., 'retries_attempted').
- hasKey() : mixed
- isConnectionError() : bool
- Returns true if this is a connection error.
- isMaxRetriesExceeded() : bool
- Returns whether the max number of retries is exceeded.
- offsetExists() : bool
- offsetGet() : mixed|null
- This method returns a reference to the variable to allow for indirect array modification (e.g., $foo['bar']['baz'] = 'qux').
- offsetSet() : void
- offsetUnset() : void
- prependMonitoringEvent() : mixed
- Prepend a client-side monitoring event to this object's event list
- search() : mixed
- setMaxRetriesExceeded() : mixed
- Sets the flag for max number of retries exceeded.
- setTransferInfo() : mixed
- Replace the transfer information associated with an exception.
- toArray() : mixed
Methods
__construct()
public
__construct(string $message, CommandInterface $command[, array<string|int, mixed> $context = [] ][, Exception $previous = null ]) : mixed
Parameters
- $message : string
-
Exception message
- $command : CommandInterface
- $context : array<string|int, mixed> = []
-
Exception context
- $previous : Exception = null
-
Previous exception (if any)
__toString()
public
__toString() : mixed
appendMonitoringEvent()
Append a client-side monitoring event to this object's event list
public
appendMonitoringEvent(array<string|int, mixed> $event) : mixed
Parameters
- $event : array<string|int, mixed>
count()
public
count() : int
Return values
intget()
public
get(mixed $key) : mixed
Parameters
- $key : mixed
getAwsErrorCode()
Get the AWS error code.
public
getAwsErrorCode() : string|null
Return values
string|null —Returns null if no response was received
getAwsErrorMessage()
Get the concise error message if any.
public
getAwsErrorMessage() : string|null
Return values
string|nullgetAwsErrorShape()
Get the AWS error shape.
public
getAwsErrorShape() : Shape|null
Return values
Shape|null —Returns null if no response was received
getAwsErrorType()
Get the AWS error type.
public
getAwsErrorType() : string|null
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
Return values
string|null —Returns null if no response was received
getCommand()
Get the command that was executed.
public
getCommand() : CommandInterface
Return values
CommandInterfacegetIterator()
public
getIterator() : Traversable
Return values
TraversablegetMonitoringEvents()
Get client-side monitoring events attached to this object. Each event is represented as an associative array within the returned array.
public
getMonitoringEvents() : array<string|int, mixed>
Return values
array<string|int, mixed>getRequest()
Get the sent HTTP request if any.
public
getRequest() : RequestInterface|null
Return values
RequestInterface|nullgetResponse()
Get the received HTTP response if any.
public
getResponse() : ResponseInterface|null
Return values
ResponseInterface|nullgetResult()
Get the result of the exception if available
public
getResult() : ResultInterface|null
Return values
ResultInterface|nullgetStatusCode()
If available, gets the HTTP status code of the corresponding response
public
getStatusCode() : int|null
Return values
int|nullgetTransferInfo()
Get all transfer information as an associative array if no $name argument is supplied, or gets a specific transfer statistic if a $name attribute is supplied (e.g., 'retries_attempted').
public
getTransferInfo([string $name = null ]) : mixed|null|array<string|int, mixed>
Parameters
- $name : string = null
-
Name of the transfer stat to retrieve
Return values
mixed|null|array<string|int, mixed>hasKey()
public
hasKey(mixed $name) : mixed
Parameters
- $name : mixed
isConnectionError()
Returns true if this is a connection error.
public
isConnectionError() : bool
Return values
boolisMaxRetriesExceeded()
Returns whether the max number of retries is exceeded.
public
isMaxRetriesExceeded() : bool
Return values
booloffsetExists()
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
This method returns a reference to the variable to allow for indirect array modification (e.g., $foo['bar']['baz'] = 'qux').
public
& offsetGet( $offset) : mixed|null
Parameters
Return values
mixed|nulloffsetSet()
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
- $value : mixed
offsetUnset()
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
prependMonitoringEvent()
Prepend a client-side monitoring event to this object's event list
public
prependMonitoringEvent(array<string|int, mixed> $event) : mixed
Parameters
- $event : array<string|int, mixed>
search()
public
search(mixed $expression) : mixed
Parameters
- $expression : mixed
setMaxRetriesExceeded()
Sets the flag for max number of retries exceeded.
public
setMaxRetriesExceeded() : mixed
setTransferInfo()
Replace the transfer information associated with an exception.
public
setTransferInfo(array<string|int, mixed> $info) : mixed
Parameters
- $info : array<string|int, mixed>
toArray()
public
toArray() : mixed