Class AwsException
- Exception
-
RuntimeException
-
Aws\Exception\AwsException
implements
Aws\MonitoringEventsInterface,
Aws\ResponseContainerInterface,
ArrayAccess
uses
Aws\HasDataTrait,
Aws\HasMonitoringEventsTrait
- Namespace: Aws\Exception
- Located at Exception/AwsException.php
Represents an AWS exception that is thrown when a command fails.
Direct known subclasses
Aws\Acm\Exception\AcmException,
Aws\ACMPCA\Exception\ACMPCAException,
Aws\ApplicationInsights\Exception\ApplicationInsightsException,
Aws\IoTThingsGraph\Exception\IoTThingsGraphException,
Aws\Kafka\Exception\KafkaException,
Aws\Kinesis\Exception\KinesisException,
Aws\KinesisAnalytics\Exception\KinesisAnalyticsException,
Aws\KinesisAnalyticsV2\Exception\KinesisAnalyticsV2Exception,
Aws\KinesisVideo\Exception\KinesisVideoException,
Aws\KinesisVideoArchivedMedia\Exception\KinesisVideoArchivedMediaException,
Aws\KinesisVideoMedia\Exception\KinesisVideoMediaException,
Aws\Kms\Exception\KmsException,
Aws\LakeFormation\Exception\LakeFormationException,
Aws\AppMesh\Exception\AppMeshException,
Aws\Lambda\Exception\LambdaException,
Aws\LexModelBuildingService\Exception\LexModelBuildingServiceException,
Aws\LexRuntimeService\Exception\LexRuntimeServiceException,
Aws\LicenseManager\Exception\LicenseManagerException,
Aws\Lightsail\Exception\LightsailException,
Aws\MachineLearning\Exception\MachineLearningException,
Aws\Macie\Exception\MacieException,
Aws\ManagedBlockchain\Exception\ManagedBlockchainException,
Aws\MarketplaceCatalog\Exception\MarketplaceCatalogException,
Aws\MarketplaceCommerceAnalytics\Exception\MarketplaceCommerceAnalyticsException,
Aws\Appstream\Exception\AppstreamException,
Aws\MarketplaceEntitlementService\Exception\MarketplaceEntitlementServiceException,
Aws\MarketplaceMetering\Exception\MarketplaceMeteringException,
Aws\MediaConnect\Exception\MediaConnectException,
Aws\MediaConvert\Exception\MediaConvertException,
Aws\MediaLive\Exception\MediaLiveException,
Aws\MediaPackage\Exception\MediaPackageException,
Aws\MediaPackageVod\Exception\MediaPackageVodException,
Aws\MediaStore\Exception\MediaStoreException,
Aws\MediaStoreData\Exception\MediaStoreDataException,
Aws\MediaTailor\Exception\MediaTailorException,
Aws\AppSync\Exception\AppSyncException,
Aws\MigrationHub\Exception\MigrationHubException,
Aws\MigrationHubConfig\Exception\MigrationHubConfigException,
Aws\Mobile\Exception\MobileException,
Aws\MQ\Exception\MQException,
Aws\MTurk\Exception\MTurkException,
Aws\Neptune\Exception\NeptuneException,
Aws\OpsWorks\Exception\OpsWorksException,
Aws\OpsWorksCM\Exception\OpsWorksCMException,
Aws\Organizations\Exception\OrganizationsException,
Aws\Personalize\Exception\PersonalizeException,
Aws\Athena\Exception\AthenaException,
Aws\PersonalizeEvents\Exception\PersonalizeEventsException,
Aws\PersonalizeRuntime\Exception\PersonalizeRuntimeException,
Aws\PI\Exception\PIException,
Aws\Pinpoint\Exception\PinpointException,
Aws\PinpointEmail\Exception\PinpointEmailException,
Aws\PinpointSMSVoice\Exception\PinpointSMSVoiceException,
Aws\Polly\Exception\PollyException,
Aws\Pricing\Exception\PricingException,
Aws\QLDB\Exception\QLDBException,
Aws\QLDBSession\Exception\QLDBSessionException,
Aws\AutoScaling\Exception\AutoScalingException,
Aws\QuickSight\Exception\QuickSightException,
Aws\RAM\Exception\RAMException,
Aws\Rds\Exception\RdsException,
Aws\RDSDataService\Exception\RDSDataServiceException,
Aws\Redshift\Exception\RedshiftException,
Aws\Rekognition\Exception\RekognitionException,
Aws\ResourceGroups\Exception\ResourceGroupsException,
Aws\ResourceGroupsTaggingAPI\Exception\ResourceGroupsTaggingAPIException,
Aws\RoboMaker\Exception\RoboMakerException,
Aws\Route53\Exception\Route53Exception,
Aws\AutoScalingPlans\Exception\AutoScalingPlansException,
Aws\Route53Domains\Exception\Route53DomainsException,
Aws\Route53Resolver\Exception\Route53ResolverException,
Aws\S3\Exception\S3Exception,
Aws\S3Control\Exception\S3ControlException,
Aws\SageMaker\Exception\SageMakerException,
Aws\SageMakerRuntime\Exception\SageMakerRuntimeException,
Aws\SavingsPlans\Exception\SavingsPlansException,
Aws\SecretsManager\Exception\SecretsManagerException,
Aws\SecurityHub\Exception\SecurityHubException,
Aws\ServerlessApplicationRepository\Exception\ServerlessApplicationRepositoryException,
Aws\Backup\Exception\BackupException,
Aws\ServiceCatalog\Exception\ServiceCatalogException,
Aws\ServiceDiscovery\Exception\ServiceDiscoveryException,
Aws\ServiceQuotas\Exception\ServiceQuotasException,
Aws\Ses\Exception\SesException,
Aws\SesV2\Exception\SesV2Exception,
Aws\Sfn\Exception\SfnException,
Aws\Shield\Exception\ShieldException,
Aws\signer\Exception\signerException,
Aws\Sms\Exception\SmsException,
Aws\SnowBall\Exception\SnowBallException,
Aws\Batch\Exception\BatchException,
Aws\Sns\Exception\SnsException,
Aws\Sqs\Exception\SqsException,
Aws\Ssm\Exception\SsmException,
Aws\SSO\Exception\SSOException,
Aws\SSOOIDC\Exception\SSOOIDCException,
Aws\StorageGateway\Exception\StorageGatewayException,
Aws\Sts\Exception\StsException,
Aws\Support\Exception\SupportException,
Aws\Swf\Exception\SwfException,
Aws\Textract\Exception\TextractException,
Aws\Budgets\Exception\BudgetsException,
Aws\TranscribeService\Exception\TranscribeServiceException,
Aws\Transfer\Exception\TransferException,
Aws\Translate\Exception\TranslateException,
Aws\Waf\Exception\WafException,
Aws\WafRegional\Exception\WafRegionalException,
Aws\WAFV2\Exception\WAFV2Exception,
Aws\WorkDocs\Exception\WorkDocsException,
Aws\WorkLink\Exception\WorkLinkException,
Aws\WorkMail\Exception\WorkMailException,
Aws\WorkMailMessageFlow\Exception\WorkMailMessageFlowException,
Aws\AlexaForBusiness\Exception\AlexaForBusinessException,
Aws\Chime\Exception\ChimeException,
Aws\WorkSpaces\Exception\WorkSpacesException,
Aws\XRay\Exception\XRayException,
Aws\Cloud9\Exception\Cloud9Exception,
Aws\CloudDirectory\Exception\CloudDirectoryException,
Aws\CloudFormation\Exception\CloudFormationException,
Aws\CloudFront\Exception\CloudFrontException,
Aws\CloudHsm\Exception\CloudHsmException,
Aws\CloudHSMV2\Exception\CloudHSMV2Exception,
Aws\CloudSearch\Exception\CloudSearchException,
Aws\CloudSearchDomain\Exception\CloudSearchDomainException,
Aws\CloudTrail\Exception\CloudTrailException,
Aws\Amplify\Exception\AmplifyException,
Aws\CloudWatch\Exception\CloudWatchException,
Aws\CloudWatchEvents\Exception\CloudWatchEventsException,
Aws\CloudWatchLogs\Exception\CloudWatchLogsException,
Aws\CodeBuild\Exception\CodeBuildException,
Aws\CodeCommit\Exception\CodeCommitException,
Aws\CodeDeploy\Exception\CodeDeployException,
Aws\CodePipeline\Exception\CodePipelineException,
Aws\CodeStar\Exception\CodeStarException,
Aws\CodeStarNotifications\Exception\CodeStarNotificationsException,
Aws\CognitoIdentity\Exception\CognitoIdentityException,
Aws\ApiGateway\Exception\ApiGatewayException,
Aws\CognitoIdentityProvider\Exception\CognitoIdentityProviderException,
Aws\CognitoSync\Exception\CognitoSyncException,
Aws\Comprehend\Exception\ComprehendException,
Aws\ComprehendMedical\Exception\ComprehendMedicalException,
Aws\ConfigService\Exception\ConfigServiceException,
Aws\Connect\Exception\ConnectException,
Aws\ConnectParticipant\Exception\ConnectParticipantException,
Aws\CostandUsageReportService\Exception\CostandUsageReportServiceException,
Aws\CostExplorer\Exception\CostExplorerException,
Aws\DatabaseMigrationService\Exception\DatabaseMigrationServiceException,
Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException,
Aws\DataExchange\Exception\DataExchangeException,
Aws\DataPipeline\Exception\DataPipelineException,
Aws\DataSync\Exception\DataSyncException,
Aws\DAX\Exception\DAXException,
Aws\DeviceFarm\Exception\DeviceFarmException,
Aws\DirectConnect\Exception\DirectConnectException,
Aws\DirectoryService\Exception\DirectoryServiceException,
Aws\DLM\Exception\DLMException,
Aws\DocDB\Exception\DocDBException,
Aws\DynamoDb\Exception\DynamoDbException,
Aws\ApiGatewayV2\Exception\ApiGatewayV2Exception,
Aws\DynamoDbStreams\Exception\DynamoDbStreamsException,
Aws\Ec2\Exception\Ec2Exception,
Aws\EC2InstanceConnect\Exception\EC2InstanceConnectException,
Aws\Ecr\Exception\EcrException,
Aws\Ecs\Exception\EcsException,
Aws\Efs\Exception\EfsException,
Aws\EKS\Exception\EKSException,
Aws\ElastiCache\Exception\ElastiCacheException,
Aws\ElasticBeanstalk\Exception\ElasticBeanstalkException,
Aws\ElasticLoadBalancing\Exception\ElasticLoadBalancingException,
Aws\AppConfig\Exception\AppConfigException,
Aws\ElasticLoadBalancingV2\Exception\ElasticLoadBalancingV2Exception,
Aws\ElasticsearchService\Exception\ElasticsearchServiceException,
Aws\ElasticTranscoder\Exception\ElasticTranscoderException,
Aws\Emr\Exception\EmrException,
Aws\EventBridge\Exception\EventBridgeException,
Aws\Firehose\Exception\FirehoseException,
Aws\FMS\Exception\FMSException,
Aws\ForecastQueryService\Exception\ForecastQueryServiceException,
Aws\ForecastService\Exception\ForecastServiceException,
Aws\FSx\Exception\FSxException,
Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException,
Aws\GameLift\Exception\GameLiftException,
Aws\Glacier\Exception\GlacierException,
Aws\GlobalAccelerator\Exception\GlobalAcceleratorException,
Aws\Glue\Exception\GlueException,
Aws\Greengrass\Exception\GreengrassException,
Aws\GroundStation\Exception\GroundStationException,
Aws\GuardDuty\Exception\GuardDutyException,
Aws\Health\Exception\HealthException,
Aws\Iam\Exception\IamException,
Aws\ImportExport\Exception\ImportExportException,
Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException,
Aws\Inspector\Exception\InspectorException,
Aws\IoT1ClickDevicesService\Exception\IoT1ClickDevicesServiceException,
Aws\IoT1ClickProjects\Exception\IoT1ClickProjectsException,
Aws\Iot\Exception\IotException,
Aws\IoTAnalytics\Exception\IoTAnalyticsException,
Aws\IotDataPlane\Exception\IotDataPlaneException,
Aws\IoTEvents\Exception\IoTEventsException,
Aws\IoTEventsData\Exception\IoTEventsDataException,
Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException,
Aws\IoTSecureTunneling\Exception\IoTSecureTunnelingException
Indirect known subclasses
Methods Summary
- __construct ( string $message, Aws\CommandInterface $command, array $context = [], Exception $previous = null )
- __toString ( )
-
getCommand ( )
Get the command that was executed.
-
getAwsErrorMessage ( )
Get the concise error message if any.
-
getRequest ( )
Get the sent HTTP request if any.
-
getResponse ( )
Get the received HTTP response if any.
-
getResult ( )
Get the result of the exception if available
-
isConnectionError ( )
Returns true if this is a connection error.
-
getStatusCode ( )
If available, gets the HTTP status code of the corresponding response
-
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.
-
getAwsErrorType ( )
Get the AWS error type.
-
getAwsErrorCode ( )
Get the AWS error code.
-
getTransferInfo ( string $name = null )
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').
-
setTransferInfo ( array $info )
Replace the transfer information associated with an exception.
-
isMaxRetriesExceeded ( )
Returns whether the max number of retries is exceeded.
-
setMaxRetriesExceeded ( )
Sets the flag for max number of retries exceeded.
- hasKey ( $name )
- get ( $key )
- search ( $expression )
Methods inherited from Exception
__wakeup(),
getCode(),
getFile(),
getLine(),
getMessage(),
getPrevious(),
getTrace(),
getTraceAsString()
Methods inherited from Aws\MonitoringEventsInterface
Methods inherited from ArrayAccess
offsetExists(),
offsetGet(),
offsetSet(),
offsetUnset()
Methods used from Aws\HasDataTrait
Methods used from Aws\HasMonitoringEventsTrait
Methods Details
__construct (
string
$message,
Aws\CommandInterface
$command,
array
$context = [],
Exception
$previous = null
)
Parameters
| string | $message | Exception message |
Aws\CommandInterface |
$command | |
| array | $context = [] | Exception context |
| Exception | $previous = null | Previous exception (if any) |
Overrides
Exception::__construct__toString ( )
Overrides
Exception::__toString
Aws\CommandInterface
getCommand (
)
string|null getAwsErrorMessage ( )
Get the concise error message if any.
Returns
| string|null |
Psr\Http\Message\RequestInterface|null
getRequest (
)
Psr\Http\Message\ResponseInterface|null
getResponse (
)
Get the received HTTP response if any.
Returns
Psr\Http\Message\ResponseInterface|null |
Implementation of
Aws\ResultInterface|null
getResult (
)
boolean isConnectionError ( )
Returns true if this is a connection error.
Returns
| boolean |
integer|null getStatusCode ( )
If available, gets the HTTP status code of the corresponding response
Returns
| integer|null |
string|null 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.
Returns
| string|null Returns null if no response was received |
string|null getAwsErrorType ( )
Get the AWS error type.
Returns
| string|null Returns null if no response was received |
string|null getAwsErrorCode ( )
Get the AWS error code.
Returns
| string|null Returns null if no response was received |
mixed|null|array getTransferInfo ( string $name = null )
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').
Parameters
| string | $name = null | Name of the transfer stat to retrieve |
Returns
| mixed|null|array |
setTransferInfo ( array $info )
Replace the transfer information associated with an exception.
Parameters
| array | $info |
boolean isMaxRetriesExceeded ( )
Returns whether the max number of retries is exceeded.
Returns
| boolean |
setMaxRetriesExceeded ( )
Sets the flag for max number of retries exceeded.
