AWS SDK for PHP 3.x
  • Namespace
  • Class
Did this page help you? SUBMIT FEEDBACK!

Namespaces

  • Aws
    • AccessAnalyzer
      • Exception
    • Account
      • Exception
    • Acm
      • Exception
    • ACMPCA
      • Exception
    • AlexaForBusiness
      • Exception
    • Amplify
      • Exception
    • AmplifyBackend
      • Exception
    • AmplifyUIBuilder
      • Exception
    • Api
      • ErrorParser
      • Parser
        • Exception
      • Serializer
    • ApiGateway
      • Exception
    • ApiGatewayManagementApi
      • Exception
    • ApiGatewayV2
      • Exception
    • AppConfig
      • Exception
    • AppConfigData
      • Exception
    • Appflow
      • Exception
    • AppIntegrationsService
      • Exception
    • ApplicationAutoScaling
      • Exception
    • ApplicationCostProfiler
      • Exception
    • ApplicationDiscoveryService
      • Exception
    • ApplicationInsights
      • Exception
    • AppMesh
      • Exception
    • AppRegistry
      • Exception
    • AppRunner
      • Exception
    • Appstream
      • Exception
    • AppSync
      • Exception
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • BackupGateway
      • Exception
    • Batch
      • Exception
    • BillingConductor
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ChimeSDKIdentity
      • Exception
    • ChimeSDKMediaPipelines
      • Exception
    • ChimeSDKMeetings
      • Exception
    • ChimeSDKMessaging
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudControlApi
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchEvidently
      • Exception
    • CloudWatchLogs
      • Exception
    • CloudWatchRUM
      • Exception
    • CodeArtifact
      • Exception
    • CodeBuild
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodeGuruProfiler
      • Exception
    • CodeGuruReviewer
      • Exception
    • CodePipeline
      • Exception
    • CodeStar
      • Exception
    • CodeStarconnections
      • Exception
    • CodeStarNotifications
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoIdentityProvider
      • Exception
    • CognitoSync
      • Exception
    • Comprehend
      • Exception
    • ComprehendMedical
      • Exception
    • ComputeOptimizer
      • Exception
    • ConfigService
      • Exception
    • Connect
      • Exception
    • ConnectCampaignService
      • Exception
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • ConnectWisdomService
      • Exception
    • CostandUsageReportService
      • Exception
    • CostExplorer
      • Exception
    • Credentials
    • Crypto
      • Cipher
      • Polyfill
    • CustomerProfiles
      • Exception
    • DatabaseMigrationService
      • Exception
    • DataExchange
      • Exception
    • DataPipeline
      • Exception
    • DataSync
      • Exception
    • DAX
      • Exception
    • DefaultsMode
      • Exception
    • Detective
      • Exception
    • DeviceFarm
      • Exception
    • DevOpsGuru
      • Exception
    • DirectConnect
      • Exception
    • DirectoryService
      • Exception
    • DLM
      • Exception
    • DocDB
      • Exception
    • drs
      • Exception
    • DynamoDb
      • Exception
    • DynamoDbStreams
      • Exception
    • EBS
      • Exception
    • Ec2
      • Exception
    • EC2InstanceConnect
      • Exception
    • Ecr
      • Exception
    • ECRPublic
      • Exception
    • Ecs
      • Exception
    • Efs
      • Exception
    • EKS
      • Exception
    • ElastiCache
      • Exception
    • ElasticBeanstalk
      • Exception
    • ElasticInference
      • Exception
    • ElasticLoadBalancing
      • Exception
    • ElasticLoadBalancingV2
      • Exception
    • ElasticsearchService
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Exception
    • EMRContainers
      • Exception
    • EMRServerless
      • Exception
    • Endpoint
      • UseDualstackEndpoint
        • Exception
      • UseFipsEndpoint
        • Exception
    • EndpointDiscovery
      • Exception
    • EventBridge
      • Exception
    • Exception
    • finspace
      • Exception
    • FinSpaceData
      • Exception
    • Firehose
      • Exception
    • FIS
      • Exception
    • FMS
      • Exception
    • ForecastQueryService
      • Exception
    • ForecastService
      • Exception
    • FraudDetector
      • Exception
    • FSx
      • Exception
    • GameLift
      • Exception
    • GameSparks
      • Exception
    • Glacier
      • Exception
    • GlobalAccelerator
      • Exception
    • Glue
      • Exception
    • GlueDataBrew
      • Exception
    • Greengrass
      • Exception
    • GreengrassV2
      • Exception
    • GroundStation
      • Exception
    • GuardDuty
      • Exception
    • Handler
      • GuzzleV5
      • GuzzleV6
    • Health
      • Exception
    • HealthLake
      • Exception
    • Honeycode
      • Exception
    • Iam
      • Exception
    • IdentityStore
      • Exception
    • imagebuilder
      • Exception
    • ImportExport
      • Exception
    • Inspector
      • Exception
    • Inspector2
      • Exception
    • Iot
      • Exception
    • IoT1ClickDevicesService
      • Exception
    • IoT1ClickProjects
      • Exception
    • IoTAnalytics
      • Exception
    • IotDataPlane
      • Exception
    • IoTDeviceAdvisor
      • Exception
    • IoTEvents
      • Exception
    • IoTEventsData
      • Exception
    • IoTFleetHub
      • Exception
    • IoTJobsDataPlane
      • Exception
    • IoTSecureTunneling
      • Exception
    • IoTSiteWise
      • Exception
    • IoTThingsGraph
      • Exception
    • IoTTwinMaker
      • Exception
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • ivschat
      • Exception
    • Kafka
      • Exception
    • KafkaConnect
      • Exception
    • kendra
      • Exception
    • Keyspaces
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisAnalyticsV2
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • KinesisVideoSignalingChannels
      • Exception
    • Kms
      • Exception
    • LakeFormation
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexModelsV2
      • Exception
    • LexRuntimeService
      • Exception
    • LexRuntimeV2
      • Exception
    • LicenseManager
      • Exception
    • LicenseManagerUserSubscriptions
      • Exception
    • Lightsail
      • Exception
    • LocationService
      • Exception
    • LookoutEquipment
      • Exception
    • LookoutforVision
      • Exception
    • LookoutMetrics
      • Exception
    • MachineLearning
      • Exception
    • Macie
      • Exception
    • Macie2
      • Exception
    • MainframeModernization
      • Exception
    • ManagedBlockchain
      • Exception
    • ManagedGrafana
      • Exception
    • MarketplaceCatalog
      • Exception
    • MarketplaceCommerceAnalytics
      • Exception
    • MarketplaceEntitlementService
      • Exception
    • MarketplaceMetering
      • Exception
    • MediaConnect
      • Exception
    • MediaConvert
      • Exception
    • MediaLive
      • Exception
    • MediaPackage
      • Exception
    • MediaPackageVod
      • Exception
    • MediaStore
      • Exception
    • MediaStoreData
      • Exception
    • MediaTailor
      • Exception
    • MemoryDB
      • Exception
    • mgn
      • Exception
    • MigrationHub
      • Exception
    • MigrationHubConfig
      • Exception
    • MigrationHubRefactorSpaces
      • Exception
    • MigrationHubStrategyRecommendations
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • NimbleStudio
      • Exception
    • OpenSearchService
      • Exception
    • OpsWorks
      • Exception
    • OpsWorksCM
      • Exception
    • Organizations
      • Exception
    • Outposts
      • Exception
    • Panorama
      • Exception
    • Personalize
      • Exception
    • PersonalizeEvents
      • Exception
    • PersonalizeRuntime
      • Exception
    • PI
      • Exception
    • Pinpoint
      • Exception
    • PinpointEmail
      • Exception
    • PinpointSMSVoice
      • Exception
    • PinpointSMSVoiceV2
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrometheusService
      • Exception
    • Proton
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • RecycleBin
      • Exception
    • Redshift
      • Exception
    • RedshiftDataAPIService
      • Exception
    • RedshiftServerless
      • Exception
    • Rekognition
      • Exception
    • ResilienceHub
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Retry
      • Exception
    • RoboMaker
      • Exception
    • RolesAnywhere
      • Exception
    • Route53
      • Exception
    • Route53Domains
      • Exception
    • Route53RecoveryCluster
      • Exception
    • Route53RecoveryControlConfig
      • Exception
    • Route53RecoveryReadiness
      • Exception
    • Route53Resolver
      • Exception
    • S3
      • Crypto
      • Exception
      • RegionalEndpoint
        • Exception
      • UseArnRegion
        • Exception
    • S3Control
      • Exception
    • S3Outposts
      • Exception
    • SageMaker
      • Exception
    • SagemakerEdgeManager
      • Exception
    • SageMakerFeatureStoreRuntime
      • Exception
    • SageMakerRuntime
      • Exception
    • SavingsPlans
      • Exception
    • Schemas
      • Exception
    • Script
      • Composer
    • SecretsManager
      • Exception
    • SecurityHub
      • Exception
    • ServerlessApplicationRepository
      • Exception
    • ServiceCatalog
      • Exception
    • ServiceDiscovery
      • Exception
    • ServiceQuotas
      • Exception
    • Ses
      • Exception
    • SesV2
      • Exception
    • Sfn
      • Exception
    • Shield
      • Exception
    • Signature
    • signer
      • Exception
    • Sms
      • Exception
    • SnowBall
      • Exception
    • SnowDeviceManagement
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSMContacts
      • Exception
    • SSMIncidents
      • Exception
    • SSO
      • Exception
    • SSOAdmin
      • Exception
    • SSOOIDC
      • Exception
    • StorageGateway
      • Exception
    • Sts
      • Exception
      • RegionalEndpoints
        • Exception
    • Support
      • Exception
    • Swf
      • Exception
    • Synthetics
      • Exception
    • Textract
      • Exception
    • TimestreamQuery
      • Exception
    • TimestreamWrite
      • Exception
    • TranscribeService
      • Exception
    • Transfer
      • Exception
    • Translate
      • Exception
    • VoiceID
      • Exception
    • Waf
      • Exception
    • WafRegional
      • Exception
    • WAFV2
      • Exception
    • WellArchitected
      • Exception
    • WorkDocs
      • Exception
    • WorkLink
      • Exception
    • WorkMail
      • Exception
    • WorkMailMessageFlow
      • Exception
    • WorkSpaces
      • Exception
    • WorkSpacesWeb
      • Exception
    • XRay
      • Exception
  • GuzzleHttp
    • Promise
    • Psr7
  • Psr
    • Http
      • Message

Exceptions

  • InspectorException

Class InspectorException

Exception
Extended by RuntimeException
Extended by Aws\Exception\AwsException implements Aws\MonitoringEventsInterface, Aws\ResponseContainerInterface, ArrayAccess uses Aws\HasDataTrait, Aws\HasMonitoringEventsTrait
Extended by Aws\Inspector\Exception\InspectorException
Namespace: Aws\Inspector\Exception
Located at Inspector/Exception/InspectorException.php

Represents an error interacting with the Amazon Inspector service.

Methods Summary

Methods inherited from Aws\Exception\AwsException

__construct(), __toString(), get(), getAwsErrorCode(), getAwsErrorMessage(), getAwsErrorShape(), getAwsErrorType(), getAwsRequestId(), getCommand(), getRequest(), getResponse(), getResult(), getStatusCode(), getTransferInfo(), hasKey(), isConnectionError(), isMaxRetriesExceeded(), search(), setMaxRetriesExceeded(), setTransferInfo()

Methods inherited from Exception

__wakeup(), getCode(), getFile(), getLine(), getMessage(), getPrevious(), getTrace(), getTraceAsString()

Methods inherited from ArrayAccess

offsetExists(), offsetGet(), offsetSet(), offsetUnset()

Methods inherited from Aws\MonitoringEventsInterface

appendMonitoringEvent(), getMonitoringEvents(), prependMonitoringEvent()

Methods used from Aws\HasDataTrait

count(), getIterator(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), toArray()

Methods used from Aws\HasMonitoringEventsTrait

appendMonitoringEvent(), getMonitoringEvents(), prependMonitoringEvent()

Expected Exception Codes

The following are the known exception codes and corresponding data shapes that this service may return as part of an error response.

AccessDeniedException

[
    'canRetry' => true || false,
    'errorCode' => 'ACCESS_DENIED_TO_ASSESSMENT_TARGET|ACCESS_DENIED_TO_ASSESSMENT_TEMPLATE|ACCESS_DENIED_TO_ASSESSMENT_RUN|ACCESS_DENIED_TO_FINDING|ACCESS_DENIED_TO_RESOURCE_GROUP|ACCESS_DENIED_TO_RULES_PACKAGE|ACCESS_DENIED_TO_SNS_TOPIC|ACCESS_DENIED_TO_IAM_ROLE',
    'message' => '<string>',
]
Description

You do not have required permissions to access the requested resource.

Members
canRetry
  • Required: Yes
  • Type: boolean

You can immediately retry your request.

errorCode
  • Required: Yes
  • Type: string

Code that indicates the type of error that is generated.

message
  • Required: Yes
  • Type: string

Details of the exception error.

AgentsAlreadyRunningAssessmentException

[
    'agents' => [
        [
            'agentId' => '<string>',
            'assessmentRunArn' => '<string>',
        ],
        // ...
    ],
    'agentsTruncated' => true || false,
    'canRetry' => true || false,
    'message' => '<string>',
]
Description

You started an assessment run, but one of the instances is already participating in another assessment run.

Members
agents
  • Required: Yes
  • Type: Array of AgentAlreadyRunningAssessment structures

agentsTruncated
  • Required: Yes
  • Type: boolean

canRetry
  • Required: Yes
  • Type: boolean

You can immediately retry your request.

message
  • Required: Yes
  • Type: string

Details of the exception error.

AssessmentRunInProgressException

[
    'assessmentRunArns' => ['<string>', ...],
    'assessmentRunArnsTruncated' => true || false,
    'canRetry' => true || false,
    'message' => '<string>',
]
Description

You cannot perform a specified action if an assessment run is currently in progress.

Members
assessmentRunArns
  • Required: Yes
  • Type: Array of strings

The ARNs of the assessment runs that are currently in progress.

assessmentRunArnsTruncated
  • Required: Yes
  • Type: boolean

Boolean value that indicates whether the ARN list of the assessment runs is truncated.

canRetry
  • Required: Yes
  • Type: boolean

You can immediately retry your request.

message
  • Required: Yes
  • Type: string

Details of the exception error.

InternalException

[
    'canRetry' => true || false,
    'message' => '<string>',
]
Description

Internal server error.

Members
canRetry
  • Required: Yes
  • Type: boolean

You can immediately retry your request.

message
  • Required: Yes
  • Type: string

Details of the exception error.

InvalidCrossAccountRoleException

[
    'canRetry' => true || false,
    'errorCode' => 'ROLE_DOES_NOT_EXIST_OR_INVALID_TRUST_RELATIONSHIP|ROLE_DOES_NOT_HAVE_CORRECT_POLICY',
    'message' => '<string>',
]
Description

Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the assessment run.

Members
canRetry
  • Required: Yes
  • Type: boolean

You can immediately retry your request.

errorCode
  • Required: Yes
  • Type: string

Code that indicates the type of error that is generated.

message
  • Required: Yes
  • Type: string

Details of the exception error.

InvalidInputException

[
    'canRetry' => true || false,
    'errorCode' => 'INVALID_ASSESSMENT_TARGET_ARN|INVALID_ASSESSMENT_TEMPLATE_ARN|INVALID_ASSESSMENT_RUN_ARN|INVALID_FINDING_ARN|INVALID_RESOURCE_GROUP_ARN|INVALID_RULES_PACKAGE_ARN|INVALID_RESOURCE_ARN|INVALID_SNS_TOPIC_ARN|INVALID_IAM_ROLE_ARN|INVALID_ASSESSMENT_TARGET_NAME|INVALID_ASSESSMENT_TARGET_NAME_PATTERN|INVALID_ASSESSMENT_TEMPLATE_NAME|INVALID_ASSESSMENT_TEMPLATE_NAME_PATTERN|INVALID_ASSESSMENT_TEMPLATE_DURATION|INVALID_ASSESSMENT_TEMPLATE_DURATION_RANGE|INVALID_ASSESSMENT_RUN_DURATION_RANGE|INVALID_ASSESSMENT_RUN_START_TIME_RANGE|INVALID_ASSESSMENT_RUN_COMPLETION_TIME_RANGE|INVALID_ASSESSMENT_RUN_STATE_CHANGE_TIME_RANGE|INVALID_ASSESSMENT_RUN_STATE|INVALID_TAG|INVALID_TAG_KEY|INVALID_TAG_VALUE|INVALID_RESOURCE_GROUP_TAG_KEY|INVALID_RESOURCE_GROUP_TAG_VALUE|INVALID_ATTRIBUTE|INVALID_USER_ATTRIBUTE|INVALID_USER_ATTRIBUTE_KEY|INVALID_USER_ATTRIBUTE_VALUE|INVALID_PAGINATION_TOKEN|INVALID_MAX_RESULTS|INVALID_AGENT_ID|INVALID_AUTO_SCALING_GROUP|INVALID_RULE_NAME|INVALID_SEVERITY|INVALID_LOCALE|INVALID_EVENT|ASSESSMENT_TARGET_NAME_ALREADY_TAKEN|ASSESSMENT_TEMPLATE_NAME_ALREADY_TAKEN|INVALID_NUMBER_OF_ASSESSMENT_TARGET_ARNS|INVALID_NUMBER_OF_ASSESSMENT_TEMPLATE_ARNS|INVALID_NUMBER_OF_ASSESSMENT_RUN_ARNS|INVALID_NUMBER_OF_FINDING_ARNS|INVALID_NUMBER_OF_RESOURCE_GROUP_ARNS|INVALID_NUMBER_OF_RULES_PACKAGE_ARNS|INVALID_NUMBER_OF_ASSESSMENT_RUN_STATES|INVALID_NUMBER_OF_TAGS|INVALID_NUMBER_OF_RESOURCE_GROUP_TAGS|INVALID_NUMBER_OF_ATTRIBUTES|INVALID_NUMBER_OF_USER_ATTRIBUTES|INVALID_NUMBER_OF_AGENT_IDS|INVALID_NUMBER_OF_AUTO_SCALING_GROUPS|INVALID_NUMBER_OF_RULE_NAMES|INVALID_NUMBER_OF_SEVERITIES',
    'message' => '<string>',
]
Description

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

Members
canRetry
  • Required: Yes
  • Type: boolean

You can immediately retry your request.

errorCode
  • Required: Yes
  • Type: string

Code that indicates the type of error that is generated.

message
  • Required: Yes
  • Type: string

Details of the exception error.

LimitExceededException

[
    'canRetry' => true || false,
    'errorCode' => 'ASSESSMENT_TARGET_LIMIT_EXCEEDED|ASSESSMENT_TEMPLATE_LIMIT_EXCEEDED|ASSESSMENT_RUN_LIMIT_EXCEEDED|RESOURCE_GROUP_LIMIT_EXCEEDED|EVENT_SUBSCRIPTION_LIMIT_EXCEEDED',
    'message' => '<string>',
]
Description

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

Members
canRetry
  • Required: Yes
  • Type: boolean

You can immediately retry your request.

errorCode
  • Required: Yes
  • Type: string

Code that indicates the type of error that is generated.

message
  • Required: Yes
  • Type: string

Details of the exception error.

NoSuchEntityException

[
    'canRetry' => true || false,
    'errorCode' => 'ASSESSMENT_TARGET_DOES_NOT_EXIST|ASSESSMENT_TEMPLATE_DOES_NOT_EXIST|ASSESSMENT_RUN_DOES_NOT_EXIST|FINDING_DOES_NOT_EXIST|RESOURCE_GROUP_DOES_NOT_EXIST|RULES_PACKAGE_DOES_NOT_EXIST|SNS_TOPIC_DOES_NOT_EXIST|IAM_ROLE_DOES_NOT_EXIST',
    'message' => '<string>',
]
Description

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

Members
canRetry
  • Required: Yes
  • Type: boolean

You can immediately retry your request.

errorCode
  • Required: Yes
  • Type: string

Code that indicates the type of error that is generated.

message
  • Required: Yes
  • Type: string

Details of the exception error.

PreviewGenerationInProgressException

[
    'message' => '<string>',
]
Description

The request is rejected. The specified assessment template is currently generating an exclusions preview.

Members
message
  • Required: Yes
  • Type: string

ServiceTemporarilyUnavailableException

[
    'canRetry' => true || false,
    'message' => '<string>',
]
Description

The serice is temporary unavailable.

Members
canRetry
  • Required: Yes
  • Type: boolean

You can wait and then retry your request.

message
  • Required: Yes
  • Type: string

Details of the exception error.

UnsupportedFeatureException

[
    'canRetry' => true || false,
    'message' => '<string>',
]
Description

Used by the GetAssessmentReport API. The request was rejected because you tried to generate a report for an assessment run that existed before reporting was supported in Amazon Inspector. You can only generate reports for assessment runs that took place or will take place after generating reports in Amazon Inspector became available.

Members
canRetry
  • Required: Yes
  • Type: boolean
message
  • Required: Yes
  • Type: string
AWS SDK for PHP 3.x API documentation generated by ApiGen