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
    • ARCZonalShift
      • Exception
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • BackupGateway
      • Exception
    • BackupStorage
      • Exception
    • Batch
      • Exception
    • BillingConductor
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ChimeSDKIdentity
      • Exception
    • ChimeSDKMediaPipelines
      • Exception
    • ChimeSDKMeetings
      • Exception
    • ChimeSDKMessaging
      • Exception
    • ChimeSDKVoice
      • Exception
    • CleanRooms
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudControlApi
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudTrailData
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchEvidently
      • Exception
    • CloudWatchLogs
      • Exception
    • CloudWatchRUM
      • Exception
    • CodeArtifact
      • Exception
    • CodeBuild
      • Exception
    • CodeCatalyst
      • 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
    • ConnectCases
      • Exception
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • ConnectWisdomService
      • Exception
    • ControlTower
      • 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
    • DocDBElastic
      • 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
    • EndpointV2
      • Rule
      • Ruleset
    • 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
    • IoTFleetWise
      • Exception
    • IoTJobsDataPlane
      • Exception
    • IoTRoboRunner
      • Exception
    • IoTSecureTunneling
      • Exception
    • IoTSiteWise
      • Exception
    • IoTThingsGraph
      • Exception
    • IoTTwinMaker
      • Exception
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • ivschat
      • Exception
    • Kafka
      • Exception
    • KafkaConnect
      • Exception
    • kendra
      • Exception
    • KendraRanking
      • Exception
    • Keyspaces
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisAnalyticsV2
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • KinesisVideoSignalingChannels
      • Exception
    • KinesisVideoWebRTCStorage
      • Exception
    • Kms
      • Exception
    • LakeFormation
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexModelsV2
      • Exception
    • LexRuntimeService
      • Exception
    • LexRuntimeV2
      • Exception
    • LicenseManager
      • Exception
    • LicenseManagerLinuxSubscriptions
      • 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
    • MigrationHubOrchestrator
      • Exception
    • MigrationHubRefactorSpaces
      • Exception
    • MigrationHubStrategyRecommendations
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • NimbleStudio
      • Exception
    • OAM
      • Exception
    • Omics
      • Exception
    • OpenSearchServerless
      • 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
    • Pipes
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrivateNetworks
      • 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
    • ResourceExplorer2
      • 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
    • SageMakerGeospatial
      • Exception
    • SageMakerMetrics
      • Exception
    • SageMakerRuntime
      • Exception
    • SavingsPlans
      • Exception
    • Scheduler
      • Exception
    • Schemas
      • Exception
    • Script
      • Composer
    • SecretsManager
      • Exception
    • SecurityHub
      • Exception
    • SecurityLake
      • Exception
    • ServerlessApplicationRepository
      • Exception
    • ServiceCatalog
      • Exception
    • ServiceDiscovery
      • Exception
    • ServiceQuotas
      • Exception
    • Ses
      • Exception
    • SesV2
      • Exception
    • Sfn
      • Exception
    • Shield
      • Exception
    • Signature
    • signer
      • Exception
    • SimSpaceWeaver
      • Exception
    • Sms
      • Exception
    • SnowBall
      • Exception
    • SnowDeviceManagement
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSMContacts
      • Exception
    • SSMIncidents
      • Exception
    • SsmSap
      • Exception
    • SSO
      • Exception
    • SSOAdmin
      • Exception
    • SSOOIDC
      • Exception
    • StorageGateway
      • Exception
    • Sts
      • Exception
      • RegionalEndpoints
        • Exception
    • Support
      • Exception
    • SupportApp
      • Exception
    • Swf
      • Exception
    • Synthetics
      • Exception
    • Textract
      • Exception
    • TimestreamQuery
      • Exception
    • TimestreamWrite
      • Exception
    • Token
    • 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

  • FSxException

Class FSxException

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

Represents an error interacting with the Amazon FSx 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.

ActiveDirectoryError

[
    'ActiveDirectoryId' => '<string>',
    'Message' => '<string>',
    'Type' => 'DOMAIN_NOT_FOUND|INCOMPATIBLE_DOMAIN_MODE|WRONG_VPC|INVALID_DOMAIN_STAGE',
]
Description

An Active Directory error.

Members
ActiveDirectoryId
  • Required: Yes
  • Type: string

The directory ID of the directory that an error pertains to.

Message
  • Type: string

A detailed error message.

Type
  • Type: string

The type of Active Directory error.

BackupBeingCopied

[
    'BackupId' => '<string>',
    'Message' => '<string>',
]
Description

You can't delete a backup while it's being copied.

Members
BackupId
  • Type: string

The ID of the source backup. Specifies the backup that you are copying.

Message
  • Type: string

A detailed error message.

BackupInProgress

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

Another backup is already under way. Wait for completion before initiating additional backups of this file system.

Members
Message
  • Type: string

A detailed error message.

BackupNotFound

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

No Amazon FSx backups were found based upon the supplied parameters.

Members
Message
  • Type: string

A detailed error message.

BackupRestoring

[
    'FileSystemId' => '<string>',
    'Message' => '<string>',
]
Description

You can't delete a backup while it's being used to restore a file system.

Members
FileSystemId
  • Type: string

The ID of a file system being restored from the backup.

Message
  • Type: string

A detailed error message.

BadRequest

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

A generic error indicating a failure with a client request.

Members
Message
  • Type: string

A detailed error message.

DataRepositoryAssociationNotFound

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

No data repository associations were found based upon the supplied parameters.

Members
Message
  • Type: string

A detailed error message.

DataRepositoryTaskEnded

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

The data repository task could not be canceled because the task has already ended.

Members
Message
  • Type: string

A detailed error message.

DataRepositoryTaskExecuting

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

An existing data repository task is currently executing on the file system. Wait until the existing task has completed, then create the new task.

Members
Message
  • Type: string

A detailed error message.

DataRepositoryTaskNotFound

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

The data repository task or tasks you specified could not be found.

Members
Message
  • Type: string

A detailed error message.

FileCacheNotFound

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

No caches were found based upon supplied parameters.

Members
Message
  • Type: string

A detailed error message.

FileSystemNotFound

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

No Amazon FSx file systems were found based upon supplied parameters.

Members
Message
  • Type: string

A detailed error message.

IncompatibleParameterError

[
    'Message' => '<string>',
    'Parameter' => '<string>',
]
Description

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

Members
Message
  • Type: string

A detailed error message.

Parameter
  • Required: Yes
  • Type: string

A parameter that is incompatible with the earlier request.

IncompatibleRegionForMultiAZ

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

Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the destination Region, so the copied backup can't be restored.

Members
Message
  • Type: string

A detailed error message.

InternalServerError

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

A generic error indicating a server-side failure.

Members
Message
  • Type: string

A detailed error message.

InvalidDataRepositoryType

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

You have filtered the response to a data repository type that is not supported.

Members
Message
  • Type: string

A detailed error message.

InvalidDestinationKmsKey

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

The Key Management Service (KMS) key of the destination backup is not valid.

Members
Message
  • Type: string

A detailed error message.

InvalidExportPath

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

The path provided for data repository export isn't valid.

Members
Message
  • Type: string

A detailed error message.

InvalidImportPath

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

The path provided for data repository import isn't valid.

Members
Message
  • Type: string

A detailed error message.

InvalidNetworkSettings

[
    'InvalidRouteTableId' => '<string>',
    'InvalidSecurityGroupId' => '<string>',
    'InvalidSubnetId' => '<string>',
    'Message' => '<string>',
]
Description

One or more network settings specified in the request are invalid.

Members
InvalidRouteTableId
  • Type: string

The route table ID is either invalid or not part of the VPC specified.

InvalidSecurityGroupId
  • Type: string

The security group ID is either invalid or not part of the VPC specified.

InvalidSubnetId
  • Type: string

The subnet ID that is either invalid or not part of the VPC specified.

Message
  • Type: string

Error message explaining what's wrong with network settings.

InvalidPerUnitStorageThroughput

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

An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.

Members
Message
  • Type: string

A detailed error message.

InvalidRegion

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

The Region provided for SourceRegion is not valid or is in a different Amazon Web Services partition.

Members
Message
  • Type: string

A detailed error message.

InvalidSourceKmsKey

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

The Key Management Service (KMS) key of the source backup is not valid.

Members
Message
  • Type: string

A detailed error message.

MissingFileCacheConfiguration

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

A cache configuration is required for this operation.

Members
Message
  • Type: string

A detailed error message.

MissingFileSystemConfiguration

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

A file system configuration is required for this operation.

Members
Message
  • Type: string

A detailed error message.

MissingVolumeConfiguration

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

A volume configuration is required for this operation.

Members
Message
  • Type: string

A detailed error message.

NotServiceResourceError

[
    'Message' => '<string>',
    'ResourceARN' => '<string>',
]
Description

The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.

Members
Message
  • Type: string

A detailed error message.

ResourceARN
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the non-Amazon FSx resource.

ResourceDoesNotSupportTagging

[
    'Message' => '<string>',
    'ResourceARN' => '<string>',
]
Description

The resource specified does not support tagging.

Members
Message
  • Type: string

A detailed error message.

ResourceARN
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource that doesn't support tagging.

ResourceNotFound

[
    'Message' => '<string>',
    'ResourceARN' => '<string>',
]
Description

The resource specified by the Amazon Resource Name (ARN) can't be found.

Members
Message
  • Type: string

A detailed error message.

ResourceARN
  • Required: Yes
  • Type: string

The resource ARN of the resource that can't be found.

ServiceLimitExceeded

[
    'Limit' => 'FILE_SYSTEM_COUNT|TOTAL_THROUGHPUT_CAPACITY|TOTAL_STORAGE|TOTAL_USER_INITIATED_BACKUPS|TOTAL_USER_TAGS|TOTAL_IN_PROGRESS_COPY_BACKUPS|STORAGE_VIRTUAL_MACHINES_PER_FILE_SYSTEM|VOLUMES_PER_FILE_SYSTEM|TOTAL_SSD_IOPS|FILE_CACHE_COUNT',
    'Message' => '<string>',
]
Description

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

Members
Limit
  • Required: Yes
  • Type: string

Enumeration of the service limit that was exceeded.

Message
  • Type: string

A detailed error message.

SnapshotNotFound

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

No Amazon FSx snapshots were found based on the supplied parameters.

Members
Message
  • Type: string

A detailed error message.

SourceBackupUnavailable

[
    'BackupId' => '<string>',
    'Message' => '<string>',
]
Description

The request was rejected because the lifecycle status of the source backup isn't AVAILABLE.

Members
BackupId
  • Type: string

The ID of the source backup. Specifies the backup that you are copying.

Message
  • Type: string

A detailed error message.

StorageVirtualMachineNotFound

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

No FSx for ONTAP SVMs were found based upon the supplied parameters.

Members
Message
  • Type: string

A detailed error message.

UnsupportedOperation

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

The requested operation is not supported for this resource or API.

Members
Message
  • Type: string

A detailed error message.

VolumeNotFound

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

No Amazon FSx volumes were found based upon the supplied parameters.

Members
Message
  • Type: string

A detailed error message.

AWS SDK for PHP 3.x API documentation generated by ApiGen