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

Namespaces

  • Aws
    • AccessAnalyzer
      • Exception
    • Acm
      • Exception
    • ACMPCA
      • Exception
    • AlexaForBusiness
      • Exception
    • Amplify
      • Exception
    • AmplifyBackend
      • Exception
    • Api
      • ErrorParser
      • Parser
        • Exception
      • Serializer
    • ApiGateway
      • Exception
    • ApiGatewayManagementApi
      • Exception
    • ApiGatewayV2
      • Exception
    • AppConfig
      • Exception
    • Appflow
      • Exception
    • AppIntegrationsService
      • Exception
    • ApplicationAutoScaling
      • Exception
    • ApplicationDiscoveryService
      • Exception
    • ApplicationInsights
      • Exception
    • AppMesh
      • Exception
    • AppRegistry
      • Exception
    • Appstream
      • Exception
    • AppSync
      • Exception
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • Batch
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchLogs
      • 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
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • CostandUsageReportService
      • Exception
    • CostExplorer
      • Exception
    • Credentials
    • Crypto
      • Cipher
      • Polyfill
    • CustomerProfiles
      • Exception
    • DatabaseMigrationService
      • Exception
    • DataExchange
      • Exception
    • DataPipeline
      • Exception
    • DataSync
      • Exception
    • DAX
      • Exception
    • Detective
      • Exception
    • DeviceFarm
      • Exception
    • DevOpsGuru
      • Exception
    • DirectConnect
      • Exception
    • DirectoryService
      • Exception
    • DLM
      • Exception
    • DocDB
      • 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
    • Endpoint
    • EndpointDiscovery
      • Exception
    • EventBridge
      • Exception
    • Exception
    • Firehose
      • Exception
    • FMS
      • Exception
    • ForecastQueryService
      • Exception
    • ForecastService
      • Exception
    • FraudDetector
      • Exception
    • FSx
      • Exception
    • GameLift
      • 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
    • 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
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • Kafka
      • Exception
    • kendra
      • 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
    • Lightsail
      • Exception
    • LocationService
      • Exception
    • LookoutforVision
      • Exception
    • MachineLearning
      • Exception
    • Macie
      • Exception
    • Macie2
      • Exception
    • ManagedBlockchain
      • 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
    • MigrationHub
      • Exception
    • MigrationHubConfig
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • OpsWorks
      • Exception
    • OpsWorksCM
      • Exception
    • Organizations
      • Exception
    • Outposts
      • Exception
    • Personalize
      • Exception
    • PersonalizeEvents
      • Exception
    • PersonalizeRuntime
      • Exception
    • PI
      • Exception
    • Pinpoint
      • Exception
    • PinpointEmail
      • Exception
    • PinpointSMSVoice
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrometheusService
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • Redshift
      • Exception
    • RedshiftDataAPIService
      • Exception
    • Rekognition
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Retry
      • Exception
    • RoboMaker
      • Exception
    • Route53
      • Exception
    • Route53Domains
      • 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
    • 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
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • 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
    • Waf
      • Exception
    • WafRegional
      • Exception
    • WAFV2
      • Exception
    • WellArchitected
      • Exception
    • WorkDocs
      • Exception
    • WorkLink
      • Exception
    • WorkMail
      • Exception
    • WorkMailMessageFlow
      • Exception
    • WorkSpaces
      • Exception
    • XRay
      • Exception
  • GuzzleHttp
    • Promise
    • Psr7
  • Psr
    • Http
      • Message

Classes

  • Aws\AbstractConfigurationProvider
  • Aws\AccessAnalyzer\AccessAnalyzerClient
  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Amplify\AmplifyClient
  • Aws\AmplifyBackend\AmplifyBackendClient
  • Aws\Api\AbstractModel
  • Aws\Api\ApiProvider
  • Aws\Api\DateTimeResult
  • Aws\Api\DocModel
  • Aws\Api\ErrorParser\AbstractErrorParser
  • Aws\Api\ErrorParser\JsonRpcErrorParser
  • Aws\Api\ErrorParser\RestJsonErrorParser
  • Aws\Api\ErrorParser\XmlErrorParser
  • Aws\Api\ListShape
  • Aws\Api\MapShape
  • Aws\Api\Operation
  • Aws\Api\Parser\Crc32ValidatingParser
  • Aws\Api\Parser\DecodingEventStreamIterator
  • Aws\Api\Parser\EventParsingIterator
  • Aws\Api\Parser\JsonParser
  • Aws\Api\Parser\JsonRpcParser
  • Aws\Api\Parser\QueryParser
  • Aws\Api\Parser\RestJsonParser
  • Aws\Api\Parser\RestXmlParser
  • Aws\Api\Parser\XmlParser
  • Aws\Api\Serializer\XmlBody
  • Aws\Api\Service
  • Aws\Api\Shape
  • Aws\Api\ShapeMap
  • Aws\Api\StructureShape
  • Aws\Api\TimestampShape
  • Aws\Api\Validator
  • Aws\ApiGateway\ApiGatewayClient
  • Aws\ApiGatewayManagementApi\ApiGatewayManagementApiClient
  • Aws\ApiGatewayV2\ApiGatewayV2Client
  • Aws\AppConfig\AppConfigClient
  • Aws\Appflow\AppflowClient
  • Aws\AppIntegrationsService\AppIntegrationsServiceClient
  • Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\ApplicationInsights\ApplicationInsightsClient
  • Aws\AppMesh\AppMeshClient
  • Aws\AppRegistry\AppRegistryClient
  • Aws\Appstream\AppstreamClient
  • Aws\AppSync\AppSyncClient
  • Aws\Athena\AthenaClient
  • Aws\AuditManager\AuditManagerClient
  • Aws\AugmentedAIRuntime\AugmentedAIRuntimeClient
  • Aws\AutoScaling\AutoScalingClient
  • Aws\AutoScalingPlans\AutoScalingPlansClient
  • Aws\AwsClient
  • Aws\Backup\BackupClient
  • Aws\Batch\BatchClient
  • Aws\Braket\BraketClient
  • Aws\Budgets\BudgetsClient
  • Aws\Chime\ChimeClient
  • Aws\ClientResolver
  • Aws\ClientSideMonitoring\Configuration
  • Aws\ClientSideMonitoring\ConfigurationProvider
  • Aws\Cloud9\Cloud9Client
  • Aws\CloudDirectory\CloudDirectoryClient
  • Aws\CloudFormation\CloudFormationClient
  • Aws\CloudFront\CloudFrontClient
  • Aws\CloudFront\CookieSigner
  • Aws\CloudFront\UrlSigner
  • Aws\CloudHsm\CloudHsmClient
  • Aws\CloudHSMV2\CloudHSMV2Client
  • Aws\CloudSearch\CloudSearchClient
  • Aws\CloudSearchDomain\CloudSearchDomainClient
  • Aws\CloudTrail\CloudTrailClient
  • Aws\CloudTrail\LogFileIterator
  • Aws\CloudTrail\LogFileReader
  • Aws\CloudTrail\LogRecordIterator
  • Aws\CloudWatch\CloudWatchClient
  • Aws\CloudWatchEvents\CloudWatchEventsClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CodeArtifact\CodeArtifactClient
  • Aws\CodeBuild\CodeBuildClient
  • Aws\CodeCommit\CodeCommitClient
  • Aws\CodeDeploy\CodeDeployClient
  • Aws\CodeGuruProfiler\CodeGuruProfilerClient
  • Aws\CodeGuruReviewer\CodeGuruReviewerClient
  • Aws\CodePipeline\CodePipelineClient
  • Aws\CodeStar\CodeStarClient
  • Aws\CodeStarconnections\CodeStarconnectionsClient
  • Aws\CodeStarNotifications\CodeStarNotificationsClient
  • Aws\CognitoIdentity\CognitoIdentityClient
  • Aws\CognitoIdentity\CognitoIdentityProvider
  • Aws\CognitoIdentityProvider\CognitoIdentityProviderClient
  • Aws\CognitoSync\CognitoSyncClient
  • Aws\Command
  • Aws\CommandPool
  • Aws\Comprehend\ComprehendClient
  • Aws\ComprehendMedical\ComprehendMedicalClient
  • Aws\ComputeOptimizer\ComputeOptimizerClient
  • Aws\ConfigService\ConfigServiceClient
  • Aws\Connect\ConnectClient
  • Aws\ConnectContactLens\ConnectContactLensClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • Aws\CostandUsageReportService\CostandUsageReportServiceClient
  • Aws\CostExplorer\CostExplorerClient
  • Aws\Credentials\AssumeRoleCredentialProvider
  • Aws\Credentials\AssumeRoleWithWebIdentityCredentialProvider
  • Aws\Credentials\CredentialProvider
  • Aws\Credentials\Credentials
  • Aws\Credentials\EcsCredentialProvider
  • Aws\Credentials\InstanceProfileProvider
  • Aws\Crypto\AesDecryptingStream
  • Aws\Crypto\AesEncryptingStream
  • Aws\Crypto\AesGcmDecryptingStream
  • Aws\Crypto\AesGcmEncryptingStream
  • Aws\Crypto\Cipher\Cbc
  • Aws\Crypto\KmsMaterialsProvider
  • Aws\Crypto\KmsMaterialsProviderV2
  • Aws\Crypto\MaterialsProvider
  • Aws\Crypto\MaterialsProviderV2
  • Aws\Crypto\Polyfill\AesGcm
  • Aws\Crypto\Polyfill\ByteArray
  • Aws\Crypto\Polyfill\Gmac
  • Aws\Crypto\Polyfill\Key
  • Aws\CustomerProfiles\CustomerProfilesClient
  • Aws\DatabaseMigrationService\DatabaseMigrationServiceClient
  • Aws\DataExchange\DataExchangeClient
  • Aws\DataPipeline\DataPipelineClient
  • Aws\DataSync\DataSyncClient
  • Aws\DAX\DAXClient
  • Aws\Detective\DetectiveClient
  • Aws\DeviceFarm\DeviceFarmClient
  • Aws\DevOpsGuru\DevOpsGuruClient
  • Aws\DirectConnect\DirectConnectClient
  • Aws\DirectoryService\DirectoryServiceClient
  • Aws\DLM\DLMClient
  • Aws\DocDB\DocDBClient
  • Aws\DoctrineCacheAdapter
  • Aws\DynamoDb\BinaryValue
  • Aws\DynamoDb\DynamoDbClient
  • Aws\DynamoDb\LockingSessionConnection
  • Aws\DynamoDb\Marshaler
  • Aws\DynamoDb\NumberValue
  • Aws\DynamoDb\SessionHandler
  • Aws\DynamoDb\SetValue
  • Aws\DynamoDb\StandardSessionConnection
  • Aws\DynamoDb\WriteRequestBatch
  • Aws\DynamoDbStreams\DynamoDbStreamsClient
  • Aws\EBS\EBSClient
  • Aws\Ec2\Ec2Client
  • Aws\EC2InstanceConnect\EC2InstanceConnectClient
  • Aws\Ecr\EcrClient
  • Aws\ECRPublic\ECRPublicClient
  • Aws\Ecs\EcsClient
  • Aws\Efs\EfsClient
  • Aws\EKS\EKSClient
  • Aws\ElastiCache\ElastiCacheClient
  • Aws\ElasticBeanstalk\ElasticBeanstalkClient
  • Aws\ElasticInference\ElasticInferenceClient
  • Aws\ElasticLoadBalancing\ElasticLoadBalancingClient
  • Aws\ElasticLoadBalancingV2\ElasticLoadBalancingV2Client
  • Aws\ElasticsearchService\ElasticsearchServiceClient
  • Aws\ElasticTranscoder\ElasticTranscoderClient
  • Aws\Emr\EmrClient
  • Aws\EMRContainers\EMRContainersClient
  • Aws\Endpoint\EndpointProvider
  • Aws\Endpoint\Partition
  • Aws\Endpoint\PartitionEndpointProvider
  • Aws\Endpoint\PatternEndpointProvider
  • Aws\EndpointDiscovery\Configuration
  • Aws\EndpointDiscovery\ConfigurationProvider
  • Aws\EndpointDiscovery\EndpointDiscoveryMiddleware
  • Aws\EndpointDiscovery\EndpointList
  • Aws\EventBridge\EventBridgeClient
  • Aws\Firehose\FirehoseClient
  • Aws\FMS\FMSClient
  • Aws\ForecastQueryService\ForecastQueryServiceClient
  • Aws\ForecastService\ForecastServiceClient
  • Aws\FraudDetector\FraudDetectorClient
  • Aws\FSx\FSxClient
  • Aws\GameLift\GameLiftClient
  • Aws\Glacier\GlacierClient
  • Aws\Glacier\MultipartUploader
  • Aws\Glacier\TreeHash
  • Aws\GlobalAccelerator\GlobalAcceleratorClient
  • Aws\Glue\GlueClient
  • Aws\GlueDataBrew\GlueDataBrewClient
  • Aws\Greengrass\GreengrassClient
  • Aws\GreengrassV2\GreengrassV2Client
  • Aws\GroundStation\GroundStationClient
  • Aws\GuardDuty\GuardDutyClient
  • Aws\Handler\GuzzleV5\GuzzleHandler
  • Aws\Handler\GuzzleV5\GuzzleStream
  • Aws\Handler\GuzzleV5\PsrStream
  • Aws\Handler\GuzzleV6\GuzzleHandler
  • Aws\HandlerList
  • Aws\HashingStream
  • Aws\Health\HealthClient
  • Aws\HealthLake\HealthLakeClient
  • Aws\History
  • Aws\Honeycode\HoneycodeClient
  • Aws\Iam\IamClient
  • Aws\IdempotencyTokenMiddleware
  • Aws\IdentityStore\IdentityStoreClient
  • Aws\imagebuilder\imagebuilderClient
  • Aws\ImportExport\ImportExportClient
  • Aws\Inspector\InspectorClient
  • Aws\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient
  • Aws\IoT1ClickProjects\IoT1ClickProjectsClient
  • Aws\Iot\IotClient
  • Aws\IoTAnalytics\IoTAnalyticsClient
  • Aws\IotDataPlane\IotDataPlaneClient
  • Aws\IoTDeviceAdvisor\IoTDeviceAdvisorClient
  • Aws\IoTEvents\IoTEventsClient
  • Aws\IoTEventsData\IoTEventsDataClient
  • Aws\IoTFleetHub\IoTFleetHubClient
  • Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
  • Aws\IoTSecureTunneling\IoTSecureTunnelingClient
  • Aws\IoTSiteWise\IoTSiteWiseClient
  • Aws\IoTThingsGraph\IoTThingsGraphClient
  • Aws\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\kendra\kendraClient
  • Aws\Kinesis\KinesisClient
  • Aws\KinesisAnalytics\KinesisAnalyticsClient
  • Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client
  • Aws\KinesisVideo\KinesisVideoClient
  • Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient
  • Aws\KinesisVideoMedia\KinesisVideoMediaClient
  • Aws\KinesisVideoSignalingChannels\KinesisVideoSignalingChannelsClient
  • Aws\Kms\KmsClient
  • Aws\LakeFormation\LakeFormationClient
  • Aws\Lambda\LambdaClient
  • Aws\LexModelBuildingService\LexModelBuildingServiceClient
  • Aws\LexModelsV2\LexModelsV2Client
  • Aws\LexRuntimeService\LexRuntimeServiceClient
  • Aws\LexRuntimeV2\LexRuntimeV2Client
  • Aws\LicenseManager\LicenseManagerClient
  • Aws\Lightsail\LightsailClient
  • Aws\LocationService\LocationServiceClient
  • Aws\LookoutforVision\LookoutforVisionClient
  • Aws\LruArrayCache
  • Aws\MachineLearning\MachineLearningClient
  • Aws\Macie2\Macie2Client
  • Aws\Macie\MacieClient
  • Aws\ManagedBlockchain\ManagedBlockchainClient
  • Aws\MarketplaceCatalog\MarketplaceCatalogClient
  • Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient
  • Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient
  • Aws\MarketplaceMetering\MarketplaceMeteringClient
  • Aws\MediaConnect\MediaConnectClient
  • Aws\MediaConvert\MediaConvertClient
  • Aws\MediaLive\MediaLiveClient
  • Aws\MediaPackage\MediaPackageClient
  • Aws\MediaPackageVod\MediaPackageVodClient
  • Aws\MediaStore\MediaStoreClient
  • Aws\MediaStoreData\MediaStoreDataClient
  • Aws\MediaTailor\MediaTailorClient
  • Aws\Middleware
  • Aws\MigrationHub\MigrationHubClient
  • Aws\MigrationHubConfig\MigrationHubConfigClient
  • Aws\Mobile\MobileClient
  • Aws\MockHandler
  • Aws\MQ\MQClient
  • Aws\MTurk\MTurkClient
  • Aws\Multipart\UploadState
  • Aws\MultiRegionClient
  • Aws\MWAA\MWAAClient
  • Aws\Neptune\NeptuneClient
  • Aws\NetworkFirewall\NetworkFirewallClient
  • Aws\NetworkManager\NetworkManagerClient
  • Aws\OpsWorks\OpsWorksClient
  • Aws\OpsWorksCM\OpsWorksCMClient
  • Aws\Organizations\OrganizationsClient
  • Aws\Outposts\OutpostsClient
  • Aws\Personalize\PersonalizeClient
  • Aws\PersonalizeEvents\PersonalizeEventsClient
  • Aws\PersonalizeRuntime\PersonalizeRuntimeClient
  • Aws\PhpHash
  • Aws\PI\PIClient
  • Aws\Pinpoint\PinpointClient
  • Aws\PinpointEmail\PinpointEmailClient
  • Aws\PinpointSMSVoice\PinpointSMSVoiceClient
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\PrometheusService\PrometheusServiceClient
  • Aws\Psr16CacheAdapter
  • Aws\PsrCacheAdapter
  • Aws\QLDB\QLDBClient
  • Aws\QLDBSession\QLDBSessionClient
  • Aws\QuickSight\QuickSightClient
  • Aws\RAM\RAMClient
  • Aws\Rds\AuthTokenGenerator
  • Aws\Rds\RdsClient
  • Aws\RDSDataService\RDSDataServiceClient
  • Aws\Redshift\RedshiftClient
  • Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
  • Aws\Rekognition\RekognitionClient
  • Aws\ResourceGroups\ResourceGroupsClient
  • Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
  • Aws\Result
  • Aws\ResultPaginator
  • Aws\Retry\Configuration
  • Aws\Retry\ConfigurationProvider
  • Aws\RoboMaker\RoboMakerClient
  • Aws\Route53\Route53Client
  • Aws\Route53Domains\Route53DomainsClient
  • Aws\Route53Resolver\Route53ResolverClient
  • Aws\S3\BatchDelete
  • Aws\S3\Crypto\HeadersMetadataStrategy
  • Aws\S3\Crypto\InstructionFileMetadataStrategy
  • Aws\S3\Crypto\S3EncryptionClient
  • Aws\S3\Crypto\S3EncryptionClientV2
  • Aws\S3\Crypto\S3EncryptionMultipartUploader
  • Aws\S3\Crypto\S3EncryptionMultipartUploaderV2
  • Aws\S3\GetBucketLocationParser
  • Aws\S3\MultipartUploader
  • Aws\S3\ObjectCopier
  • Aws\S3\ObjectUploader
  • Aws\S3\PostObject
  • Aws\S3\PostObjectV4
  • Aws\S3\RegionalEndpoint\Configuration
  • Aws\S3\RegionalEndpoint\ConfigurationProvider
  • Aws\S3\S3Client
  • Aws\S3\S3MultiRegionClient
  • Aws\S3\S3UriParser
  • Aws\S3\StreamWrapper
  • Aws\S3\Transfer
  • Aws\S3\UseArnRegion\Configuration
  • Aws\S3\UseArnRegion\ConfigurationProvider
  • Aws\S3Control\S3ControlClient
  • Aws\S3Outposts\S3OutpostsClient
  • Aws\SageMaker\SageMakerClient
  • Aws\SagemakerEdgeManager\SagemakerEdgeManagerClient
  • Aws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient
  • Aws\SageMakerRuntime\SageMakerRuntimeClient
  • Aws\SavingsPlans\SavingsPlansClient
  • Aws\Schemas\SchemasClient
  • Aws\Sdk
  • Aws\SecretsManager\SecretsManagerClient
  • Aws\SecurityHub\SecurityHubClient
  • Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient
  • Aws\ServiceCatalog\ServiceCatalogClient
  • Aws\ServiceDiscovery\ServiceDiscoveryClient
  • Aws\ServiceQuotas\ServiceQuotasClient
  • Aws\Ses\SesClient
  • Aws\SesV2\SesV2Client
  • Aws\Sfn\SfnClient
  • Aws\Shield\ShieldClient
  • Aws\Signature\AnonymousSignature
  • Aws\Signature\S3SignatureV4
  • Aws\Signature\SignatureProvider
  • Aws\Signature\SignatureV4
  • Aws\signer\signerClient
  • Aws\Sms\SmsClient
  • Aws\SnowBall\SnowBallClient
  • Aws\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • Aws\SSO\SSOClient
  • Aws\SSOAdmin\SSOAdminClient
  • Aws\SSOOIDC\SSOOIDCClient
  • Aws\StorageGateway\StorageGatewayClient
  • Aws\Sts\RegionalEndpoints\Configuration
  • Aws\Sts\RegionalEndpoints\ConfigurationProvider
  • Aws\Sts\StsClient
  • Aws\Support\SupportClient
  • Aws\Swf\SwfClient
  • Aws\Synthetics\SyntheticsClient
  • Aws\Textract\TextractClient
  • Aws\TimestreamQuery\TimestreamQueryClient
  • Aws\TimestreamWrite\TimestreamWriteClient
  • Aws\TraceMiddleware
  • Aws\TranscribeService\TranscribeServiceClient
  • Aws\Transfer\TransferClient
  • Aws\Translate\TranslateClient
  • Aws\Waf\WafClient
  • Aws\WafRegional\WafRegionalClient
  • Aws\WAFV2\WAFV2Client
  • Aws\Waiter
  • Aws\WellArchitected\WellArchitectedClient
  • Aws\WorkDocs\WorkDocsClient
  • Aws\WorkLink\WorkLinkClient
  • Aws\WorkMail\WorkMailClient
  • Aws\WorkMailMessageFlow\WorkMailMessageFlowClient
  • Aws\WorkSpaces\WorkSpacesClient
  • Aws\WrappedHttpHandler
  • Aws\XRay\XRayClient

Interfaces

  • Aws\AwsClientInterface
  • Aws\CacheInterface
  • Aws\ClientSideMonitoring\ConfigurationInterface
  • Aws\CommandInterface
  • Aws\ConfigurationProviderInterface
  • Aws\Credentials\CredentialsInterface
  • Aws\Crypto\AesStreamInterface
  • Aws\Crypto\AesStreamInterfaceV2
  • Aws\Crypto\Cipher\CipherMethod
  • Aws\Crypto\MaterialsProviderInterface
  • Aws\Crypto\MaterialsProviderInterfaceV2
  • Aws\Crypto\MetadataStrategyInterface
  • Aws\DynamoDb\SessionConnectionInterface
  • Aws\Endpoint\PartitionInterface
  • Aws\EndpointDiscovery\ConfigurationInterface
  • Aws\HashInterface
  • Aws\MonitoringEventsInterface
  • Aws\ResponseContainerInterface
  • Aws\ResultInterface
  • Aws\Retry\ConfigurationInterface
  • Aws\S3\RegionalEndpoint\ConfigurationInterface
  • Aws\S3\S3ClientInterface
  • Aws\S3\UseArnRegion\ConfigurationInterface
  • Aws\Signature\SignatureInterface
  • Aws\Sts\RegionalEndpoints\ConfigurationInterface

Traits

  • Aws\Api\ErrorParser\JsonParserTrait
  • Aws\Api\Parser\MetadataParserTrait
  • Aws\Api\Parser\PayloadParserTrait
  • Aws\AwsClientTrait
  • Aws\Crypto\Cipher\CipherBuilderTrait
  • Aws\Crypto\DecryptionTrait
  • Aws\Crypto\DecryptionTraitV2
  • Aws\Crypto\EncryptionTrait
  • Aws\Crypto\EncryptionTraitV2
  • Aws\Crypto\Polyfill\NeedsTrait
  • Aws\DynamoDb\SessionConnectionConfigTrait
  • Aws\HasDataTrait
  • Aws\HasMonitoringEventsTrait
  • Aws\Retry\RetryHelperTrait
  • Aws\S3\Crypto\CryptoParamsTrait
  • Aws\S3\Crypto\CryptoParamsTraitV2
  • Aws\S3\Crypto\UserAgentTrait
  • Aws\S3\MultipartUploadingTrait
  • Aws\S3\S3ClientTrait
  • Aws\Signature\SignatureTrait

Exceptions

  • Aws\AccessAnalyzer\Exception\AccessAnalyzerException
  • Aws\Acm\Exception\AcmException
  • Aws\ACMPCA\Exception\ACMPCAException
  • Aws\AlexaForBusiness\Exception\AlexaForBusinessException
  • Aws\Amplify\Exception\AmplifyException
  • Aws\AmplifyBackend\Exception\AmplifyBackendException
  • Aws\Api\Parser\Exception\ParserException
  • Aws\ApiGateway\Exception\ApiGatewayException
  • Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException
  • Aws\ApiGatewayV2\Exception\ApiGatewayV2Exception
  • Aws\AppConfig\Exception\AppConfigException
  • Aws\Appflow\Exception\AppflowException
  • Aws\AppIntegrationsService\Exception\AppIntegrationsServiceException
  • Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException
  • Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException
  • Aws\ApplicationInsights\Exception\ApplicationInsightsException
  • Aws\AppMesh\Exception\AppMeshException
  • Aws\AppRegistry\Exception\AppRegistryException
  • Aws\Appstream\Exception\AppstreamException
  • Aws\AppSync\Exception\AppSyncException
  • Aws\Arn\Exception\InvalidArnException
  • Aws\Athena\Exception\AthenaException
  • Aws\AuditManager\Exception\AuditManagerException
  • Aws\AugmentedAIRuntime\Exception\AugmentedAIRuntimeException
  • Aws\AutoScaling\Exception\AutoScalingException
  • Aws\AutoScalingPlans\Exception\AutoScalingPlansException
  • Aws\Backup\Exception\BackupException
  • Aws\Batch\Exception\BatchException
  • Aws\Braket\Exception\BraketException
  • Aws\Budgets\Exception\BudgetsException
  • Aws\Chime\Exception\ChimeException
  • Aws\ClientSideMonitoring\Exception\ConfigurationException
  • 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\CloudWatch\Exception\CloudWatchException
  • Aws\CloudWatchEvents\Exception\CloudWatchEventsException
  • Aws\CloudWatchLogs\Exception\CloudWatchLogsException
  • Aws\CodeArtifact\Exception\CodeArtifactException
  • Aws\CodeBuild\Exception\CodeBuildException
  • Aws\CodeCommit\Exception\CodeCommitException
  • Aws\CodeDeploy\Exception\CodeDeployException
  • Aws\CodeGuruProfiler\Exception\CodeGuruProfilerException
  • Aws\CodeGuruReviewer\Exception\CodeGuruReviewerException
  • Aws\CodePipeline\Exception\CodePipelineException
  • Aws\CodeStar\Exception\CodeStarException
  • Aws\CodeStarconnections\Exception\CodeStarconnectionsException
  • Aws\CodeStarNotifications\Exception\CodeStarNotificationsException
  • Aws\CognitoIdentity\Exception\CognitoIdentityException
  • Aws\CognitoIdentityProvider\Exception\CognitoIdentityProviderException
  • Aws\CognitoSync\Exception\CognitoSyncException
  • Aws\Comprehend\Exception\ComprehendException
  • Aws\ComprehendMedical\Exception\ComprehendMedicalException
  • Aws\ComputeOptimizer\Exception\ComputeOptimizerException
  • Aws\ConfigService\Exception\ConfigServiceException
  • Aws\Connect\Exception\ConnectException
  • Aws\ConnectContactLens\Exception\ConnectContactLensException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • Aws\CostandUsageReportService\Exception\CostandUsageReportServiceException
  • Aws\CostExplorer\Exception\CostExplorerException
  • Aws\CustomerProfiles\Exception\CustomerProfilesException
  • Aws\DatabaseMigrationService\Exception\DatabaseMigrationServiceException
  • Aws\DataExchange\Exception\DataExchangeException
  • Aws\DataPipeline\Exception\DataPipelineException
  • Aws\DataSync\Exception\DataSyncException
  • Aws\DAX\Exception\DAXException
  • Aws\Detective\Exception\DetectiveException
  • Aws\DeviceFarm\Exception\DeviceFarmException
  • Aws\DevOpsGuru\Exception\DevOpsGuruException
  • Aws\DirectConnect\Exception\DirectConnectException
  • Aws\DirectoryService\Exception\DirectoryServiceException
  • Aws\DLM\Exception\DLMException
  • Aws\DocDB\Exception\DocDBException
  • Aws\DynamoDb\Exception\DynamoDbException
  • Aws\DynamoDbStreams\Exception\DynamoDbStreamsException
  • Aws\EBS\Exception\EBSException
  • Aws\Ec2\Exception\Ec2Exception
  • Aws\EC2InstanceConnect\Exception\EC2InstanceConnectException
  • Aws\Ecr\Exception\EcrException
  • Aws\ECRPublic\Exception\ECRPublicException
  • Aws\Ecs\Exception\EcsException
  • Aws\Efs\Exception\EfsException
  • Aws\EKS\Exception\EKSException
  • Aws\ElastiCache\Exception\ElastiCacheException
  • Aws\ElasticBeanstalk\Exception\ElasticBeanstalkException
  • Aws\ElasticInference\Exception\ElasticInferenceException
  • Aws\ElasticLoadBalancing\Exception\ElasticLoadBalancingException
  • Aws\ElasticLoadBalancingV2\Exception\ElasticLoadBalancingV2Exception
  • Aws\ElasticsearchService\Exception\ElasticsearchServiceException
  • Aws\ElasticTranscoder\Exception\ElasticTranscoderException
  • Aws\Emr\Exception\EmrException
  • Aws\EMRContainers\Exception\EMRContainersException
  • Aws\EndpointDiscovery\Exception\ConfigurationException
  • Aws\EventBridge\Exception\EventBridgeException
  • Aws\Exception\AwsException
  • Aws\Exception\CouldNotCreateChecksumException
  • Aws\Exception\CredentialsException
  • Aws\Exception\CryptoException
  • Aws\Exception\CryptoPolyfillException
  • Aws\Exception\EventStreamDataException
  • Aws\Exception\IncalculablePayloadException
  • Aws\Exception\InvalidJsonException
  • Aws\Exception\InvalidRegionException
  • Aws\Exception\MultipartUploadException
  • Aws\Exception\UnresolvedApiException
  • Aws\Exception\UnresolvedEndpointException
  • Aws\Exception\UnresolvedSignatureException
  • Aws\Firehose\Exception\FirehoseException
  • Aws\FMS\Exception\FMSException
  • Aws\ForecastQueryService\Exception\ForecastQueryServiceException
  • Aws\ForecastService\Exception\ForecastServiceException
  • Aws\FraudDetector\Exception\FraudDetectorException
  • Aws\FSx\Exception\FSxException
  • Aws\GameLift\Exception\GameLiftException
  • Aws\Glacier\Exception\GlacierException
  • Aws\GlobalAccelerator\Exception\GlobalAcceleratorException
  • Aws\Glue\Exception\GlueException
  • Aws\GlueDataBrew\Exception\GlueDataBrewException
  • Aws\Greengrass\Exception\GreengrassException
  • Aws\GreengrassV2\Exception\GreengrassV2Exception
  • Aws\GroundStation\Exception\GroundStationException
  • Aws\GuardDuty\Exception\GuardDutyException
  • Aws\Health\Exception\HealthException
  • Aws\HealthLake\Exception\HealthLakeException
  • Aws\Honeycode\Exception\HoneycodeException
  • Aws\Iam\Exception\IamException
  • Aws\IdentityStore\Exception\IdentityStoreException
  • Aws\imagebuilder\Exception\imagebuilderException
  • Aws\ImportExport\Exception\ImportExportException
  • 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\IoTDeviceAdvisor\Exception\IoTDeviceAdvisorException
  • Aws\IoTEvents\Exception\IoTEventsException
  • Aws\IoTEventsData\Exception\IoTEventsDataException
  • Aws\IoTFleetHub\Exception\IoTFleetHubException
  • Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException
  • Aws\IoTSecureTunneling\Exception\IoTSecureTunnelingException
  • Aws\IoTSiteWise\Exception\IoTSiteWiseException
  • Aws\IoTThingsGraph\Exception\IoTThingsGraphException
  • Aws\IoTWireless\Exception\IoTWirelessException
  • Aws\IVS\Exception\IVSException
  • Aws\Kafka\Exception\KafkaException
  • Aws\kendra\Exception\kendraException
  • 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\KinesisVideoSignalingChannels\Exception\KinesisVideoSignalingChannelsException
  • Aws\Kms\Exception\KmsException
  • Aws\LakeFormation\Exception\LakeFormationException
  • Aws\Lambda\Exception\LambdaException
  • Aws\LexModelBuildingService\Exception\LexModelBuildingServiceException
  • Aws\LexModelsV2\Exception\LexModelsV2Exception
  • Aws\LexRuntimeService\Exception\LexRuntimeServiceException
  • Aws\LexRuntimeV2\Exception\LexRuntimeV2Exception
  • Aws\LicenseManager\Exception\LicenseManagerException
  • Aws\Lightsail\Exception\LightsailException
  • Aws\LocationService\Exception\LocationServiceException
  • Aws\LookoutforVision\Exception\LookoutforVisionException
  • Aws\MachineLearning\Exception\MachineLearningException
  • Aws\Macie2\Exception\Macie2Exception
  • Aws\Macie\Exception\MacieException
  • Aws\ManagedBlockchain\Exception\ManagedBlockchainException
  • Aws\MarketplaceCatalog\Exception\MarketplaceCatalogException
  • Aws\MarketplaceCommerceAnalytics\Exception\MarketplaceCommerceAnalyticsException
  • 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\MigrationHub\Exception\MigrationHubException
  • Aws\MigrationHubConfig\Exception\MigrationHubConfigException
  • Aws\Mobile\Exception\MobileException
  • Aws\MQ\Exception\MQException
  • Aws\MTurk\Exception\MTurkException
  • Aws\MWAA\Exception\MWAAException
  • Aws\Neptune\Exception\NeptuneException
  • Aws\NetworkFirewall\Exception\NetworkFirewallException
  • Aws\NetworkManager\Exception\NetworkManagerException
  • Aws\OpsWorks\Exception\OpsWorksException
  • Aws\OpsWorksCM\Exception\OpsWorksCMException
  • Aws\Organizations\Exception\OrganizationsException
  • Aws\Outposts\Exception\OutpostsException
  • Aws\Personalize\Exception\PersonalizeException
  • 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\PrometheusService\Exception\PrometheusServiceException
  • Aws\QLDB\Exception\QLDBException
  • Aws\QLDBSession\Exception\QLDBSessionException
  • Aws\QuickSight\Exception\QuickSightException
  • Aws\RAM\Exception\RAMException
  • Aws\Rds\Exception\RdsException
  • Aws\RDSDataService\Exception\RDSDataServiceException
  • Aws\Redshift\Exception\RedshiftException
  • Aws\RedshiftDataAPIService\Exception\RedshiftDataAPIServiceException
  • Aws\Rekognition\Exception\RekognitionException
  • Aws\ResourceGroups\Exception\ResourceGroupsException
  • Aws\ResourceGroupsTaggingAPI\Exception\ResourceGroupsTaggingAPIException
  • Aws\Retry\Exception\ConfigurationException
  • Aws\RoboMaker\Exception\RoboMakerException
  • Aws\Route53\Exception\Route53Exception
  • Aws\Route53Domains\Exception\Route53DomainsException
  • Aws\Route53Resolver\Exception\Route53ResolverException
  • Aws\S3\Exception\DeleteMultipleObjectsException
  • Aws\S3\Exception\PermanentRedirectException
  • Aws\S3\Exception\S3Exception
  • Aws\S3\Exception\S3MultipartUploadException
  • Aws\S3\RegionalEndpoint\Exception\ConfigurationException
  • Aws\S3\UseArnRegion\Exception\ConfigurationException
  • Aws\S3Control\Exception\S3ControlException
  • Aws\S3Outposts\Exception\S3OutpostsException
  • Aws\SageMaker\Exception\SageMakerException
  • Aws\SagemakerEdgeManager\Exception\SagemakerEdgeManagerException
  • Aws\SageMakerFeatureStoreRuntime\Exception\SageMakerFeatureStoreRuntimeException
  • Aws\SageMakerRuntime\Exception\SageMakerRuntimeException
  • Aws\SavingsPlans\Exception\SavingsPlansException
  • Aws\Schemas\Exception\SchemasException
  • Aws\SecretsManager\Exception\SecretsManagerException
  • Aws\SecurityHub\Exception\SecurityHubException
  • Aws\ServerlessApplicationRepository\Exception\ServerlessApplicationRepositoryException
  • 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\Sns\Exception\InvalidSnsMessageException
  • Aws\Sns\Exception\SnsException
  • Aws\Sqs\Exception\SqsException
  • Aws\Ssm\Exception\SsmException
  • Aws\SSO\Exception\SSOException
  • Aws\SSOAdmin\Exception\SSOAdminException
  • Aws\SSOOIDC\Exception\SSOOIDCException
  • Aws\StorageGateway\Exception\StorageGatewayException
  • Aws\Sts\Exception\StsException
  • Aws\Sts\RegionalEndpoints\Exception\ConfigurationException
  • Aws\Support\Exception\SupportException
  • Aws\Swf\Exception\SwfException
  • Aws\Synthetics\Exception\SyntheticsException
  • Aws\Textract\Exception\TextractException
  • Aws\TimestreamQuery\Exception\TimestreamQueryException
  • Aws\TimestreamWrite\Exception\TimestreamWriteException
  • 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\WellArchitected\Exception\WellArchitectedException
  • Aws\WorkDocs\Exception\WorkDocsException
  • Aws\WorkLink\Exception\WorkLinkException
  • Aws\WorkMail\Exception\WorkMailException
  • Aws\WorkMailMessageFlow\Exception\WorkMailMessageFlowException
  • Aws\WorkSpaces\Exception\WorkSpacesException
  • Aws\XRay\Exception\XRayException

Functions

  • Aws\boolean_value
  • Aws\clear_compiled_json
  • Aws\constantly
  • Aws\default_http_handler
  • Aws\default_user_agent
  • Aws\describe_type
  • Aws\dir_iterator
  • Aws\filter
  • Aws\flatmap
  • Aws\guzzle_major_version
  • Aws\is_valid_epoch
  • Aws\is_valid_hostlabel
  • Aws\is_valid_hostname
  • Aws\load_compiled_json
  • Aws\manifest
  • Aws\map
  • Aws\or_chain
  • Aws\parse_ini_file
  • Aws\partition
  • Aws\recursive_dir_iterator
  • Aws\serialize

Amazon FSx 2018-03-01

Client: Aws\FSx\FSxClient
Service ID: fsx
Version: 2018-03-01

This page describes the parameters and results for the operations of the Amazon FSx (2018-03-01), and shows how to use the Aws\FSx\FSxClient object to call the described operations. This documentation is specific to the 2018-03-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

  • AssociateFileSystemAliases ( array $params = [] )

    Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system.

  • CancelDataRepositoryTask ( array $params = [] )

    Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state.

  • CreateBackup ( array $params = [] )

    Creates a backup of an existing Amazon FSx file system.

  • CreateDataRepositoryTask ( array $params = [] )

    Creates an Amazon FSx for Lustre data repository task.

  • CreateFileSystem ( array $params = [] )

    Creates a new, empty Amazon FSx file system.

  • CreateFileSystemFromBackup ( array $params = [] )

    Creates a new Amazon FSx file system from an existing Amazon FSx backup.

  • DeleteBackup ( array $params = [] )

    Deletes an Amazon FSx backup, deleting its contents.

  • DeleteFileSystem ( array $params = [] )

    Deletes a file system, deleting its contents.

  • DescribeBackups ( array $params = [] )

    Returns the description of specific Amazon FSx backups, if a BackupIds value is provided for that backup.

  • DescribeDataRepositoryTasks ( array $params = [] )

    Returns the description of specific Amazon FSx for Lustre data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request.

  • DescribeFileSystemAliases ( array $params = [] )

    Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.

  • DescribeFileSystems ( array $params = [] )

    Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system.

  • DisassociateFileSystemAliases ( array $params = [] )

    Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system.

  • ListTagsForResource ( array $params = [] )

    Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.

  • TagResource ( array $params = [] )

    Tags an Amazon FSx resource.

  • UntagResource ( array $params = [] )

    This action removes a tag from an Amazon FSx resource.

  • UpdateFileSystem ( array $params = [] )

    Use this operation to update the configuration of an existing Amazon FSx file system.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

  • DescribeBackups
  • DescribeDataRepositoryTasks
  • DescribeFileSystemAliases
  • DescribeFileSystems

Operations

AssociateFileSystemAliases

$result = $client->associateFileSystemAliases([/* ... */]);
$promise = $client->associateFileSystemAliasesAsync([/* ... */]);

Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file systen can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.

Parameter Syntax

$result = $client->associateFileSystemAliases([
    'Aliases' => ['<string>', ...], // REQUIRED
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
]);

Parameter Details

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

An array of one or more DNS alias names to associate with the file system. The alias name has to comply with the following formatting requirements:

  • Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.corp.example.com.

  • Can contain alphanumeric characters and the hyphen (-).

  • Cannot start or end with a hyphen.

  • Can start with a numeric.

For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

ClientRequestToken
  • Type: string

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

FileSystemId
  • Required: Yes
  • Type: string

Specifies the file system with which you want to associate one or more DNS aliases.

Result Syntax

[
    'Aliases' => [
        [
            'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Aliases
  • Type: Array of Alias structures

An array of the DNS aliases that Amazon FSx is associating with the file system.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • FileSystemNotFound:

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

  • InternalServerError:

    A generic error indicating a server-side failure.

CancelDataRepositoryTask

$result = $client->cancelDataRepositoryTask([/* ... */]);
$promise = $client->cancelDataRepositoryTaskAsync([/* ... */]);

Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel a task, Amazon FSx does the following.

  • Any files that FSx has already exported are not reverted.

  • FSx continues to export any files that are "in-flight" when the cancel operation is received.

  • FSx does not export any files that have not yet been exported.

Parameter Syntax

$result = $client->cancelDataRepositoryTask([
    'TaskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
TaskId
  • Required: Yes
  • Type: string

Specifies the data repository task to cancel.

Result Syntax

[
    'Lifecycle' => 'PENDING|EXECUTING|FAILED|SUCCEEDED|CANCELED|CANCELING',
    'TaskId' => '<string>',
]

Result Details

Members
Lifecycle
  • Type: string

The lifecycle status of the data repository task, as follows:

  • PENDING - Amazon FSx has not started the task.

  • EXECUTING - Amazon FSx is processing the task.

  • FAILED - Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.

  • SUCCEEDED - FSx completed the task successfully.

  • CANCELED - Amazon FSx canceled the task and it did not complete.

  • CANCELING - FSx is in process of canceling the task.

TaskId
  • Type: string

The ID of the task being canceled.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • UnsupportedOperation:

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

  • DataRepositoryTaskNotFound:

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

  • DataRepositoryTaskEnded:

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

  • InternalServerError:

    A generic error indicating a server-side failure.

CreateBackup

$result = $client->createBackup([/* ... */]);
$promise = $client->createBackupAsync([/* ... */]);

Creates a backup of an existing Amazon FSx file system. Creating regular backups for your file system is a best practice, enabling you to restore a file system from a backup if an issue arises with the original file system.

For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration:

  • a Persistent deployment type

  • is not linked to a data respository.

For more information about backing up Amazon FSx for Lustre file systems, see Working with FSx for Lustre backups.

For more information about backing up Amazon FSx for Windows file systems, see Working with FSx for Windows backups.

If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:

  • Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the backup.

By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.

The CreateBackup operation returns while the backup's lifecycle state is still CREATING. You can check the backup creation status by calling the DescribeBackups operation, which returns the backup state along with other information.

Parameter Syntax

$result = $client->createBackup([
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ClientRequestToken
  • Type: string

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

FileSystemId
  • Required: Yes
  • Type: string

The ID of the file system to back up.

Tags
  • Type: Array of Tag structures

(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup action, no existing file system tags are copied from the file system to the backup.

Result Syntax

[
    'Backup' => [
        'BackupId' => '<string>',
        'CreationTime' => <DateTime>,
        'DirectoryInformation' => [
            'ActiveDirectoryId' => '<string>',
            'DomainName' => '<string>',
        ],
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystem' => [
            'AdministrativeActions' => [
                [
                    'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ProgressPercent' => <integer>,
                    'RequestTime' => <DateTime>,
                    'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                    'TargetFileSystemValues' => [...], // RECURSIVE
                ],
                // ...
            ],
            'CreationTime' => <DateTime>,
            'DNSName' => '<string>',
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystemId' => '<string>',
            'FileSystemType' => 'WINDOWS|LUSTRE',
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING',
            'LustreConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DataRepositoryConfiguration' => [
                    'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
                    'ExportPath' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ImportPath' => '<string>',
                    'ImportedFileChunkSize' => <integer>,
                    'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING',
                ],
                'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
                'DriveCacheType' => 'NONE|READ',
                'MountName' => '<string>',
                'PerUnitStorageThroughput' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'NetworkInterfaceIds' => ['<string>', ...],
            'OwnerId' => '<string>',
            'ResourceARN' => '<string>',
            'StorageCapacity' => <integer>,
            'StorageType' => 'SSD|HDD',
            'SubnetIds' => ['<string>', ...],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
            'WindowsConfiguration' => [
                'ActiveDirectoryId' => '<string>',
                'Aliases' => [
                    [
                        'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                        'Name' => '<string>',
                    ],
                    // ...
                ],
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                'MaintenanceOperationsInProgress' => ['<string>', ...],
                'PreferredFileServerIp' => '<string>',
                'PreferredSubnetId' => '<string>',
                'RemoteAdministrationEndpoint' => '<string>',
                'SelfManagedActiveDirectoryConfiguration' => [
                    'DnsIps' => ['<string>', ...],
                    'DomainName' => '<string>',
                    'FileSystemAdministratorsGroup' => '<string>',
                    'OrganizationalUnitDistinguishedName' => '<string>',
                    'UserName' => '<string>',
                ],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
        ],
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|TRANSFERRING|DELETED|FAILED|PENDING',
        'ProgressPercent' => <integer>,
        'ResourceARN' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'AUTOMATIC|USER_INITIATED|AWS_BACKUP',
    ],
]

Result Details

Members
Backup
  • Type: Backup structure

A description of the backup.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • UnsupportedOperation:

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

  • FileSystemNotFound:

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

  • BackupInProgress:

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

  • IncompatibleParameterError:

    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.

  • ServiceLimitExceeded:

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

  • InternalServerError:

    A generic error indicating a server-side failure.

Examples

Example 1: To create a new backup

This operation creates a new backup.

$result = $client->createBackup([
    'FileSystemId' => 'fs-0498eed5fe91001ec',
    'Tags' => [
        [
            'Key' => 'Name',
            'Value' => 'MyBackup',
        ],
    ],
]);

Result syntax:

[
    'Backup' => [
        'BackupId' => 'backup-03e3c82e0183b7b6b',
        'CreationTime' => ,
        'FileSystem' => [
            'FileSystemId' => 'fs-0498eed5fe91001ec',
            'OwnerId' => '012345678912',
            'StorageCapacity' => 300,
            'WindowsConfiguration' => [
                'ActiveDirectoryId' => 'd-1234abcd12',
                'AutomaticBackupRetentionDays' => 30,
                'DailyAutomaticBackupStartTime' => '05:00',
                'WeeklyMaintenanceStartTime' => '1:05:00',
            ],
        ],
        'Lifecycle' => 'CREATING',
        'ProgressPercent' => 0,
        'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b',
        'Tags' => [
            [
                'Key' => 'Name',
                'Value' => 'MyBackup',
            ],
        ],
        'Type' => 'USER_INITIATED',
    ],
]

CreateDataRepositoryTask

$result = $client->createDataRepositoryTask([/* ... */]);
$promise = $client->createDataRepositoryTaskAsync([/* ... */]);

Creates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations between your Amazon FSx file system and its linked data repository. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to its linked data repository. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system. To learn more about data repository tasks, see Data Repository Tasks. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.

Parameter Syntax

$result = $client->createDataRepositoryTask([
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
    'Paths' => ['<string>', ...],
    'Report' => [ // REQUIRED
        'Enabled' => true || false, // REQUIRED
        'Format' => 'REPORT_CSV_20191124',
        'Path' => '<string>',
        'Scope' => 'FAILED_FILES_ONLY',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Type' => 'EXPORT_TO_REPOSITORY', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
  • Type: string

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

FileSystemId
  • Required: Yes
  • Type: string

The globally unique ID of the file system, assigned by Amazon FSx.

Paths
  • Type: Array of strings

(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or file on the file system you want to export, then the path to provide is path1. If a path that you provide isn't valid, the task fails.

Report
  • Required: Yes
  • Type: CompletionReport structure

Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the Scope parameter. For more information, see Working with Task Completion Reports.

Tags
  • Type: Array of Tag structures

A list of Tag values, with a maximum of 50 elements.

Type
  • Required: Yes
  • Type: string

Specifies the type of data repository task to create.

Result Syntax

[
    'DataRepositoryTask' => [
        'CreationTime' => <DateTime>,
        'EndTime' => <DateTime>,
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'Lifecycle' => 'PENDING|EXECUTING|FAILED|SUCCEEDED|CANCELED|CANCELING',
        'Paths' => ['<string>', ...],
        'Report' => [
            'Enabled' => true || false,
            'Format' => 'REPORT_CSV_20191124',
            'Path' => '<string>',
            'Scope' => 'FAILED_FILES_ONLY',
        ],
        'ResourceARN' => '<string>',
        'StartTime' => <DateTime>,
        'Status' => [
            'FailedCount' => <integer>,
            'LastUpdatedTime' => <DateTime>,
            'SucceededCount' => <integer>,
            'TotalCount' => <integer>,
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TaskId' => '<string>',
        'Type' => 'EXPORT_TO_REPOSITORY',
    ],
]

Result Details

Members
DataRepositoryTask
  • Type: DataRepositoryTask structure

The description of the data repository task that you just created.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • UnsupportedOperation:

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

  • FileSystemNotFound:

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

  • IncompatibleParameterError:

    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.

  • ServiceLimitExceeded:

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

  • InternalServerError:

    A generic error indicating a server-side failure.

  • DataRepositoryTaskExecuting:

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

CreateFileSystem

$result = $client->createFileSystem([/* ... */]);
$promise = $client->createFileSystemAsync([/* ... */]);

Creates a new, empty Amazon FSx file system.

If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:

  • Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the file system.

This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.

Parameter Syntax

$result = $client->createFileSystem([
    'ClientRequestToken' => '<string>',
    'FileSystemType' => 'WINDOWS|LUSTRE', // REQUIRED
    'KmsKeyId' => '<string>',
    'LustreConfiguration' => [
        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
        'DriveCacheType' => 'NONE|READ',
        'ExportPath' => '<string>',
        'ImportPath' => '<string>',
        'ImportedFileChunkSize' => <integer>,
        'PerUnitStorageThroughput' => <integer>,
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'SecurityGroupIds' => ['<string>', ...],
    'StorageCapacity' => <integer>, // REQUIRED
    'StorageType' => 'SSD|HDD',
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'WindowsConfiguration' => [
        'ActiveDirectoryId' => '<string>',
        'Aliases' => ['<string>', ...],
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
        'PreferredSubnetId' => '<string>',
        'SelfManagedActiveDirectoryConfiguration' => [
            'DnsIps' => ['<string>', ...], // REQUIRED
            'DomainName' => '<string>', // REQUIRED
            'FileSystemAdministratorsGroup' => '<string>',
            'OrganizationalUnitDistinguishedName' => '<string>',
            'Password' => '<string>', // REQUIRED
            'UserName' => '<string>', // REQUIRED
        ],
        'ThroughputCapacity' => <integer>, // REQUIRED
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
]);

Parameter Details

Members
ClientRequestToken
  • Type: string

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

FileSystemType
  • Required: Yes
  • Type: string

The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.

KmsKeyId
  • Type: string

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and Amazon FSx for Lustre PERSISTENT_1 file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The Amazon FSx for Lustre SCRATCH_1 and SCRATCH_2 file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference.

LustreConfiguration
  • Type: CreateFileSystemLustreConfiguration structure

The Lustre configuration for the file system being created.

SecurityGroupIds
  • Type: Array of strings

A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.

StorageCapacity
  • Required: Yes
  • Type: int

Sets the storage capacity of the file system that you're creating.

For Lustre file systems:

  • For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.

  • For PERSISTENT HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.

  • For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.

For Windows file systems:

  • If StorageType=SSD, valid values are 32 GiB - 65,536 GiB (64 TiB).

  • If StorageType=HDD, valid values are 2000 GiB - 65,536 GiB (64 TiB).

StorageType
  • Type: string

Sets the storage type for the file system you're creating. Valid values are SSD and HDD.

  • Set to SSD to use solid state drive storage. SSD is supported on all Windows and Lustre deployment types.

  • Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT Lustre file system deployment types.

Default value is SSD. For more information, see Storage Type Options in the Amazon FSx for Windows User Guide and Multiple Storage Options in the Amazon FSx for Lustre User Guide.

SubnetIds
  • Required: Yes
  • Type: Array of strings

Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

For Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

Tags
  • Type: Array of Tag structures

The tags to apply to the file system being created. The key value of the Name tag appears in the console as the file system name.

WindowsConfiguration
  • Type: CreateFileSystemWindowsConfiguration structure

The Microsoft Windows configuration for the file system being created.

Result Syntax

[
    'FileSystem' => [
        'AdministrativeActions' => [
            [
                'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                'TargetFileSystemValues' => [...], // RECURSIVE
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING',
        'LustreConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DataRepositoryConfiguration' => [
                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
                'ExportPath' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING',
            ],
            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
            'DriveCacheType' => 'NONE|READ',
            'MountName' => '<string>',
            'PerUnitStorageThroughput' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<string>', ...],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'StorageType' => 'SSD|HDD',
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => '<string>',
            'Aliases' => [
                [
                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                    'Name' => '<string>',
                ],
                // ...
            ],
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
            'MaintenanceOperationsInProgress' => ['<string>', ...],
            'PreferredFileServerIp' => '<string>',
            'PreferredSubnetId' => '<string>',
            'RemoteAdministrationEndpoint' => '<string>',
            'SelfManagedActiveDirectoryConfiguration' => [
                'DnsIps' => ['<string>', ...],
                'DomainName' => '<string>',
                'FileSystemAdministratorsGroup' => '<string>',
                'OrganizationalUnitDistinguishedName' => '<string>',
                'UserName' => '<string>',
            ],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
    ],
]

Result Details

Members
FileSystem
  • Type: FileSystem structure

The configuration of the file system that was created.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • ActiveDirectoryError:

    An Active Directory error.

  • IncompatibleParameterError:

    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.

  • InvalidImportPath:

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

  • InvalidExportPath:

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

  • InvalidNetworkSettings:

    One or more network settings specified in the request are invalid. InvalidVpcId means that the ID passed for the virtual private cloud (VPC) is invalid. InvalidSubnetIds returns the list of IDs for subnets that are either invalid or not part of the VPC specified. InvalidSecurityGroupIds returns the list of IDs for security groups that are either invalid or not part of the VPC specified.

  • InvalidPerUnitStorageThroughput:

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

  • ServiceLimitExceeded:

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

  • InternalServerError:

    A generic error indicating a server-side failure.

  • MissingFileSystemConfiguration:

    A file system configuration is required for this operation.

Examples

Example 1: To create a new file system

This operation creates a new Amazon FSx for Windows File Server file system.

$result = $client->createFileSystem([
    'ClientRequestToken' => 'a8ca07e4-61ec-4399-99f4-19853801bcd5',
    'FileSystemType' => 'WINDOWS',
    'KmsKeyId' => 'arn:aws:kms:us-east-1:012345678912:key/1111abcd-2222-3333-4444-55556666eeff',
    'SecurityGroupIds' => [
        'sg-edcd9784',
    ],
    'StorageCapacity' => 3200,
    'StorageType' => 'HDD',
    'SubnetIds' => [
        'subnet-1234abcd',
    ],
    'Tags' => [
        [
            'Key' => 'Name',
            'Value' => 'MyFileSystem',
        ],
    ],
    'WindowsConfiguration' => [
        'ActiveDirectoryId' => 'd-1234abcd12',
        'Aliases' => [
            'accounting.corp.example.com',
        ],
        'AutomaticBackupRetentionDays' => 30,
        'DailyAutomaticBackupStartTime' => '05:00',
        'ThroughputCapacity' => 32,
        'WeeklyMaintenanceStartTime' => '1:05:00',
    ],
]);

Result syntax:

[
    'FileSystem' => [
        'CreationTime' => ,
        'DNSName' => 'fs-0123456789abcdef0.fsx.com',
        'FileSystemId' => 'fs-0123456789abcdef0',
        'KmsKeyId' => 'arn:aws:kms:us-east-1:012345678912:key/1111abcd-2222-3333-4444-55556666eeff',
        'Lifecycle' => 'CREATING',
        'OwnerId' => '012345678912',
        'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:file-system/fs-0123456789abcdef0',
        'StorageCapacity' => 3200,
        'StorageType' => 'HDD',
        'SubnetIds' => [
            'subnet-1234abcd',
        ],
        'Tags' => [
            [
                'Key' => 'Name',
                'Value' => 'MyFileSystem',
            ],
        ],
        'VpcId' => 'vpc-ab1234cd',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => 'd-1234abcd12',
            'Aliases' => [
                [
                    'Lifecycle' => 'CREATING',
                    'Name' => 'accounting.corp.example.com',
                ],
            ],
            'AutomaticBackupRetentionDays' => 30,
            'DailyAutomaticBackupStartTime' => '05:00',
            'ThroughputCapacity' => 32,
            'WeeklyMaintenanceStartTime' => '1:05:00',
        ],
    ],
]

CreateFileSystemFromBackup

$result = $client->createFileSystemFromBackup([/* ... */]);
$promise = $client->createFileSystemFromBackupAsync([/* ... */]);

Creates a new Amazon FSx file system from an existing Amazon FSx backup.

If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a client request token specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:

  • Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the file system.

Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.

By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.

Parameter Syntax

$result = $client->createFileSystemFromBackup([
    'BackupId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>',
    'LustreConfiguration' => [
        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
        'DriveCacheType' => 'NONE|READ',
        'ExportPath' => '<string>',
        'ImportPath' => '<string>',
        'ImportedFileChunkSize' => <integer>,
        'PerUnitStorageThroughput' => <integer>,
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'SecurityGroupIds' => ['<string>', ...],
    'StorageType' => 'SSD|HDD',
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'WindowsConfiguration' => [
        'ActiveDirectoryId' => '<string>',
        'Aliases' => ['<string>', ...],
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
        'PreferredSubnetId' => '<string>',
        'SelfManagedActiveDirectoryConfiguration' => [
            'DnsIps' => ['<string>', ...], // REQUIRED
            'DomainName' => '<string>', // REQUIRED
            'FileSystemAdministratorsGroup' => '<string>',
            'OrganizationalUnitDistinguishedName' => '<string>',
            'Password' => '<string>', // REQUIRED
            'UserName' => '<string>', // REQUIRED
        ],
        'ThroughputCapacity' => <integer>, // REQUIRED
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
]);

Parameter Details

Members
BackupId
  • Required: Yes
  • Type: string

The ID of the backup. Specifies the backup to use if you're creating a file system from an existing backup.

ClientRequestToken
  • Type: string

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

LustreConfiguration
  • Type: CreateFileSystemLustreConfiguration structure

The Lustre configuration for the file system being created.

SecurityGroupIds
  • Type: Array of strings

A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later DescribeFileSystem requests.

StorageType
  • Type: string

Sets the storage type for the Windows file system you're creating from a backup. Valid values are SSD and HDD.

  • Set to SSD to use solid state drive storage. Supported on all Windows deployment types.

  • Set to HDD to use hard disk drive storage. Supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types.

Default value is SSD.

HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage only if the original SSD file system had a storage capacity of at least 2000 GiB.

SubnetIds
  • Required: Yes
  • Type: Array of strings

Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

For Windows SINGLE_AZ_1 and SINGLE_AZ_2 deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

Tags
  • Type: Array of Tag structures

The tags to be applied to the file system at file system creation. The key value of the Name tag appears in the console as the file system name.

WindowsConfiguration
  • Type: CreateFileSystemWindowsConfiguration structure

The configuration for this Microsoft Windows file system.

Result Syntax

[
    'FileSystem' => [
        'AdministrativeActions' => [
            [
                'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                'TargetFileSystemValues' => [...], // RECURSIVE
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING',
        'LustreConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DataRepositoryConfiguration' => [
                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
                'ExportPath' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING',
            ],
            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
            'DriveCacheType' => 'NONE|READ',
            'MountName' => '<string>',
            'PerUnitStorageThroughput' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<string>', ...],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'StorageType' => 'SSD|HDD',
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => '<string>',
            'Aliases' => [
                [
                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                    'Name' => '<string>',
                ],
                // ...
            ],
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
            'MaintenanceOperationsInProgress' => ['<string>', ...],
            'PreferredFileServerIp' => '<string>',
            'PreferredSubnetId' => '<string>',
            'RemoteAdministrationEndpoint' => '<string>',
            'SelfManagedActiveDirectoryConfiguration' => [
                'DnsIps' => ['<string>', ...],
                'DomainName' => '<string>',
                'FileSystemAdministratorsGroup' => '<string>',
                'OrganizationalUnitDistinguishedName' => '<string>',
                'UserName' => '<string>',
            ],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
    ],
]

Result Details

Members
FileSystem
  • Type: FileSystem structure

A description of the file system.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • ActiveDirectoryError:

    An Active Directory error.

  • IncompatibleParameterError:

    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.

  • InvalidNetworkSettings:

    One or more network settings specified in the request are invalid. InvalidVpcId means that the ID passed for the virtual private cloud (VPC) is invalid. InvalidSubnetIds returns the list of IDs for subnets that are either invalid or not part of the VPC specified. InvalidSecurityGroupIds returns the list of IDs for security groups that are either invalid or not part of the VPC specified.

  • InvalidPerUnitStorageThroughput:

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

  • ServiceLimitExceeded:

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

  • BackupNotFound:

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

  • InternalServerError:

    A generic error indicating a server-side failure.

  • MissingFileSystemConfiguration:

    A file system configuration is required for this operation.

Examples

Example 1: To create a new file system from backup

This operation creates a new file system from backup.

$result = $client->createFileSystemFromBackup([
    'BackupId' => 'backup-03e3c82e0183b7b6b',
    'ClientRequestToken' => 'f4c94ed7-238d-4c46-93db-48cd62ec33b7',
    'SecurityGroupIds' => [
        'sg-edcd9784',
    ],
    'SubnetIds' => [
        'subnet-1234abcd',
    ],
    'Tags' => [
        [
            'Key' => 'Name',
            'Value' => 'MyFileSystem',
        ],
    ],
    'WindowsConfiguration' => [
        'ThroughputCapacity' => 8,
    ],
]);

Result syntax:

[
    'FileSystem' => [
        'CreationTime' => ,
        'DNSName' => 'fs-0498eed5fe91001ec.fsx.com',
        'FileSystemId' => 'fs-0498eed5fe91001ec',
        'KmsKeyId' => 'arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6',
        'Lifecycle' => 'CREATING',
        'OwnerId' => '012345678912',
        'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec',
        'StorageCapacity' => 300,
        'SubnetIds' => [
            'subnet-1234abcd',
        ],
        'Tags' => [
            [
                'Key' => 'Name',
                'Value' => 'MyFileSystem',
            ],
        ],
        'VpcId' => 'vpc-ab1234cd',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => 'd-1234abcd12',
            'AutomaticBackupRetentionDays' => 30,
            'DailyAutomaticBackupStartTime' => '05:00',
            'ThroughputCapacity' => 8,
            'WeeklyMaintenanceStartTime' => '1:05:00',
        ],
    ],
]

DeleteBackup

$result = $client->deleteBackup([/* ... */]);
$promise = $client->deleteBackupAsync([/* ... */]);

Deletes an Amazon FSx backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.

The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls.

The data in a deleted backup is also deleted and can't be recovered by any means.

Parameter Syntax

$result = $client->deleteBackup([
    'BackupId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>',
]);

Parameter Details

Members
BackupId
  • Required: Yes
  • Type: string

The ID of the backup you want to delete.

ClientRequestToken
  • Type: string

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.

Result Syntax

[
    'BackupId' => '<string>',
    'Lifecycle' => 'AVAILABLE|CREATING|TRANSFERRING|DELETED|FAILED|PENDING',
]

Result Details

Members
BackupId
  • Type: string

The ID of the backup deleted.

Lifecycle
  • Type: string

The lifecycle of the backup. Should be DELETED.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • BackupInProgress:

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

  • BackupNotFound:

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

  • BackupRestoring:

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

  • IncompatibleParameterError:

    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.

  • InternalServerError:

    A generic error indicating a server-side failure.

Examples

Example 1: To delete a backup

This operation deletes an Amazon FSx file system backup.

$result = $client->deleteBackup([
    'BackupId' => 'backup-03e3c82e0183b7b6b',
]);

Result syntax:

[
    'BackupId' => 'backup-03e3c82e0183b7b6b',
    'Lifecycle' => 'DELETED',
]

DeleteFileSystem

$result = $client->deleteFileSystem([/* ... */]);
$promise = $client->deleteFileSystemAsync([/* ... */]);

Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.

By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.

The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error.

Deleting an Amazon FSx for Lustre file system will fail with a 400 BadRequest if a data repository task is in a PENDING or EXECUTING state.

The data in a deleted file system is also deleted and can't be recovered by any means.

Parameter Syntax

$result = $client->deleteFileSystem([
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
    'LustreConfiguration' => [
        'FinalBackupTags' => [
            [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'SkipFinalBackup' => true || false,
    ],
    'WindowsConfiguration' => [
        'FinalBackupTags' => [
            [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'SkipFinalBackup' => true || false,
    ],
]);

Parameter Details

Members
ClientRequestToken
  • Type: string

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.

FileSystemId
  • Required: Yes
  • Type: string

The ID of the file system you want to delete.

LustreConfiguration
  • Type: DeleteFileSystemLustreConfiguration structure

The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

WindowsConfiguration
  • Type: DeleteFileSystemWindowsConfiguration structure

The configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation.

Result Syntax

[
    'FileSystemId' => '<string>',
    'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING',
    'LustreResponse' => [
        'FinalBackupId' => '<string>',
        'FinalBackupTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'WindowsResponse' => [
        'FinalBackupId' => '<string>',
        'FinalBackupTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
FileSystemId
  • Type: string

The ID of the file system being deleted.

Lifecycle
  • Type: string

The file system lifecycle for the deletion request. Should be DELETING.

LustreResponse
  • Type: DeleteFileSystemLustreResponse structure

The response object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

WindowsResponse
  • Type: DeleteFileSystemWindowsResponse structure

The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • IncompatibleParameterError:

    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.

  • FileSystemNotFound:

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

  • ServiceLimitExceeded:

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

  • InternalServerError:

    A generic error indicating a server-side failure.

Examples

Example 1: To delete a file system

This operation deletes an Amazon FSx file system.

$result = $client->deleteFileSystem([
    'FileSystemId' => 'fs-0498eed5fe91001ec',
]);

Result syntax:

[
    'FileSystemId' => 'fs-0498eed5fe91001ec',
    'Lifecycle' => 'DELETING',
]

DescribeBackups

$result = $client->describeBackups([/* ... */]);
$promise = $client->describeBackupsAsync([/* ... */]);

Returns the description of specific Amazon FSx backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.

Parameter Syntax

$result = $client->describeBackups([
    'BackupIds' => ['<string>', ...],
    'Filters' => [
        [
            'Name' => 'file-system-id|backup-type|file-system-type',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
BackupIds
  • Type: Array of strings

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Filters
  • Type: Array of Filter structures

Filters structure. Supported names are file-system-id and backup-type.

MaxResults
  • Type: int

Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

NextToken
  • Type: string

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Result Syntax

[
    'Backups' => [
        [
            'BackupId' => '<string>',
            'CreationTime' => <DateTime>,
            'DirectoryInformation' => [
                'ActiveDirectoryId' => '<string>',
                'DomainName' => '<string>',
            ],
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystem' => [
                'AdministrativeActions' => [
                    [
                        'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'ProgressPercent' => <integer>,
                        'RequestTime' => <DateTime>,
                        'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                        'TargetFileSystemValues' => [...], // RECURSIVE
                    ],
                    // ...
                ],
                'CreationTime' => <DateTime>,
                'DNSName' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'FileSystemId' => '<string>',
                'FileSystemType' => 'WINDOWS|LUSTRE',
                'KmsKeyId' => '<string>',
                'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING',
                'LustreConfiguration' => [
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DataRepositoryConfiguration' => [
                        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
                        'ExportPath' => '<string>',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'ImportPath' => '<string>',
                        'ImportedFileChunkSize' => <integer>,
                        'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING',
                    ],
                    'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
                    'DriveCacheType' => 'NONE|READ',
                    'MountName' => '<string>',
                    'PerUnitStorageThroughput' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'NetworkInterfaceIds' => ['<string>', ...],
                'OwnerId' => '<string>',
                'ResourceARN' => '<string>',
                'StorageCapacity' => <integer>,
                'StorageType' => 'SSD|HDD',
                'SubnetIds' => ['<string>', ...],
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'VpcId' => '<string>',
                'WindowsConfiguration' => [
                    'ActiveDirectoryId' => '<string>',
                    'Aliases' => [
                        [
                            'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                            'Name' => '<string>',
                        ],
                        // ...
                    ],
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                    'MaintenanceOperationsInProgress' => ['<string>', ...],
                    'PreferredFileServerIp' => '<string>',
                    'PreferredSubnetId' => '<string>',
                    'RemoteAdministrationEndpoint' => '<string>',
                    'SelfManagedActiveDirectoryConfiguration' => [
                        'DnsIps' => ['<string>', ...],
                        'DomainName' => '<string>',
                        'FileSystemAdministratorsGroup' => '<string>',
                        'OrganizationalUnitDistinguishedName' => '<string>',
                        'UserName' => '<string>',
                    ],
                    'ThroughputCapacity' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
            ],
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|TRANSFERRING|DELETED|FAILED|PENDING',
            'ProgressPercent' => <integer>,
            'ResourceARN' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Type' => 'AUTOMATIC|USER_INITIATED|AWS_BACKUP',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Backups
  • Type: Array of Backup structures

Any array of backups.

NextToken
  • Type: string

This is present if there are more backups than returned in the response (String). You can use the NextToken value in the later request to fetch the backups.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • FileSystemNotFound:

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

  • BackupNotFound:

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

  • InternalServerError:

    A generic error indicating a server-side failure.

Examples

Example 1: To describe Amazon FSx backups

This operation describes all of the Amazon FSx backups in an account.

$result = $client->describeBackups([
]);

Result syntax:

[
    'Backups' => [
        [
            'BackupId' => 'backup-03e3c82e0183b7b6b',
            'CreationTime' => ,
            'FileSystem' => [
                'FileSystemId' => 'fs-0498eed5fe91001ec',
                'OwnerId' => '012345678912',
                'StorageCapacity' => 300,
                'WindowsConfiguration' => [
                    'ActiveDirectoryId' => 'd-1234abcd12',
                    'AutomaticBackupRetentionDays' => 30,
                    'DailyAutomaticBackupStartTime' => '05:00',
                    'WeeklyMaintenanceStartTime' => '1:05:00',
                ],
            ],
            'Lifecycle' => 'AVAILABLE',
            'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b',
            'Tags' => [
                [
                    'Key' => 'Name',
                    'Value' => 'MyBackup',
                ],
            ],
            'Type' => 'USER_INITIATED',
        ],
    ],
]

DescribeDataRepositoryTasks

$result = $client->describeDataRepositoryTasks([/* ... */]);
$promise = $client->describeDataRepositoryTasksAsync([/* ... */]);

Returns the description of specific Amazon FSx for Lustre data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

Parameter Syntax

$result = $client->describeDataRepositoryTasks([
    'Filters' => [
        [
            'Name' => 'file-system-id|task-lifecycle',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TaskIds' => ['<string>', ...],
]);

Parameter Details

Members
Filters
  • Type: Array of DataRepositoryTaskFilter structures

(Optional) You can use filters to narrow the DescribeDataRepositoryTasks response to include just tasks for specific file systems, or tasks in a specific lifecycle state.

MaxResults
  • Type: int

The maximum number of resources to return in the response. This value must be an integer greater than zero.

NextToken
  • Type: string

(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.

TaskIds
  • Type: Array of strings

(Optional) IDs of the tasks whose descriptions you want to retrieve (String).

Result Syntax

[
    'DataRepositoryTasks' => [
        [
            'CreationTime' => <DateTime>,
            'EndTime' => <DateTime>,
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystemId' => '<string>',
            'Lifecycle' => 'PENDING|EXECUTING|FAILED|SUCCEEDED|CANCELED|CANCELING',
            'Paths' => ['<string>', ...],
            'Report' => [
                'Enabled' => true || false,
                'Format' => 'REPORT_CSV_20191124',
                'Path' => '<string>',
                'Scope' => 'FAILED_FILES_ONLY',
            ],
            'ResourceARN' => '<string>',
            'StartTime' => <DateTime>,
            'Status' => [
                'FailedCount' => <integer>,
                'LastUpdatedTime' => <DateTime>,
                'SucceededCount' => <integer>,
                'TotalCount' => <integer>,
            ],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'TaskId' => '<string>',
            'Type' => 'EXPORT_TO_REPOSITORY',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
DataRepositoryTasks
  • Type: Array of DataRepositoryTask structures

The collection of data repository task descriptions returned.

NextToken
  • Type: string

(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • FileSystemNotFound:

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

  • DataRepositoryTaskNotFound:

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

  • InternalServerError:

    A generic error indicating a server-side failure.

DescribeFileSystemAliases

$result = $client->describeFileSystemAliases([/* ... */]);
$promise = $client->describeFileSystemAliasesAsync([/* ... */]);

Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.

Parameter Syntax

$result = $client->describeFileSystemAliases([
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ClientRequestToken
  • Type: string

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

FileSystemId
  • Required: Yes
  • Type: string

The ID of the file system to return the associated DNS aliases for (String).

MaxResults
  • Type: int

Maximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

NextToken
  • Type: string

Opaque pagination token returned from a previous DescribeFileSystemAliases operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off.

Result Syntax

[
    'Aliases' => [
        [
            'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Aliases
  • Type: Array of Alias structures

An array of one or more DNS aliases currently associated with the specified file system.

NextToken
  • Type: string

Present if there are more DNS aliases than returned in the response (String). You can use the NextToken value in a later request to fetch additional descriptions.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • FileSystemNotFound:

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

  • InternalServerError:

    A generic error indicating a server-side failure.

DescribeFileSystems

$result = $client->describeFileSystems([/* ... */]);
$promise = $client->describeFileSystemsAsync([/* ... */]);

Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.

Parameter Syntax

$result = $client->describeFileSystems([
    'FileSystemIds' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
FileSystemIds
  • Type: Array of strings

IDs of the file systems whose descriptions you want to retrieve (String).

MaxResults
  • Type: int

Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

NextToken
  • Type: string

Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the action continues the list from where the returning call left off.

Result Syntax

[
    'FileSystems' => [
        [
            'AdministrativeActions' => [
                [
                    'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ProgressPercent' => <integer>,
                    'RequestTime' => <DateTime>,
                    'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                    'TargetFileSystemValues' => [...], // RECURSIVE
                ],
                // ...
            ],
            'CreationTime' => <DateTime>,
            'DNSName' => '<string>',
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystemId' => '<string>',
            'FileSystemType' => 'WINDOWS|LUSTRE',
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING',
            'LustreConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DataRepositoryConfiguration' => [
                    'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
                    'ExportPath' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ImportPath' => '<string>',
                    'ImportedFileChunkSize' => <integer>,
                    'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING',
                ],
                'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
                'DriveCacheType' => 'NONE|READ',
                'MountName' => '<string>',
                'PerUnitStorageThroughput' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'NetworkInterfaceIds' => ['<string>', ...],
            'OwnerId' => '<string>',
            'ResourceARN' => '<string>',
            'StorageCapacity' => <integer>,
            'StorageType' => 'SSD|HDD',
            'SubnetIds' => ['<string>', ...],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
            'WindowsConfiguration' => [
                'ActiveDirectoryId' => '<string>',
                'Aliases' => [
                    [
                        'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                        'Name' => '<string>',
                    ],
                    // ...
                ],
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                'MaintenanceOperationsInProgress' => ['<string>', ...],
                'PreferredFileServerIp' => '<string>',
                'PreferredSubnetId' => '<string>',
                'RemoteAdministrationEndpoint' => '<string>',
                'SelfManagedActiveDirectoryConfiguration' => [
                    'DnsIps' => ['<string>', ...],
                    'DomainName' => '<string>',
                    'FileSystemAdministratorsGroup' => '<string>',
                    'OrganizationalUnitDistinguishedName' => '<string>',
                    'UserName' => '<string>',
                ],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
FileSystems
  • Type: Array of FileSystem structures

An array of file system descriptions.

NextToken
  • Type: string

Present if there are more file systems than returned in the response (String). You can use the NextToken value in the later request to fetch the descriptions.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • FileSystemNotFound:

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

  • InternalServerError:

    A generic error indicating a server-side failure.

Examples

Example 1: To describe an Amazon FSx file system

This operation describes all of the Amazon FSx file systems in an account.

$result = $client->describeFileSystems([
]);

Result syntax:

[
    'FileSystems' => [
        [
            'CreationTime' => ,
            'DNSName' => 'fs-0498eed5fe91001ec.fsx.com',
            'FileSystemId' => 'fs-0498eed5fe91001ec',
            'KmsKeyId' => 'arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6',
            'Lifecycle' => 'AVAILABLE',
            'NetworkInterfaceIds' => [
                'eni-abcd1234',
            ],
            'OwnerId' => '012345678912',
            'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec',
            'StorageCapacity' => 300,
            'SubnetIds' => [
                'subnet-1234abcd',
            ],
            'Tags' => [
                [
                    'Key' => 'Name',
                    'Value' => 'MyFileSystem',
                ],
            ],
            'VpcId' => 'vpc-ab1234cd',
            'WindowsConfiguration' => [
                'ActiveDirectoryId' => 'd-1234abcd12',
                'AutomaticBackupRetentionDays' => 30,
                'DailyAutomaticBackupStartTime' => '05:00',
                'ThroughputCapacity' => 8,
                'WeeklyMaintenanceStartTime' => '1:05:00',
            ],
        ],
    ],
]

DisassociateFileSystemAliases

$result = $client->disassociateFileSystemAliases([/* ... */]);
$promise = $client->disassociateFileSystemAliasesAsync([/* ... */]);

Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with a 400 Bad Request. For more information, see Working with DNS Aliases.

The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.

Parameter Syntax

$result = $client->disassociateFileSystemAliases([
    'Aliases' => ['<string>', ...], // REQUIRED
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
]);

Parameter Details

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

An array of one or more DNS alias names to disassociate, or remove, from the file system.

ClientRequestToken
  • Type: string

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

FileSystemId
  • Required: Yes
  • Type: string

Specifies the file system from which to disassociate the DNS aliases.

Result Syntax

[
    'Aliases' => [
        [
            'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Aliases
  • Type: Array of Alias structures

An array of one or more DNS aliases that Amazon FSx is attempting to disassociate from the file system.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • FileSystemNotFound:

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

  • InternalServerError:

    A generic error indicating a server-side failure.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.

When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified.

Parameter Syntax

$result = $client->listTagsForResource([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
  • Type: int

Maximum number of tags to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

NextToken
  • Type: string

Opaque pagination token returned from a previous ListTagsForResource operation (String). If a token present, the action continues the list from where the returning call left off.

ResourceARN
  • Required: Yes
  • Type: string

The ARN of the Amazon FSx resource that will have its tags listed.

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

This is present if there are more tags than returned in the response (String). You can use the NextToken value in the later request to fetch the tags.

Tags
  • Type: Array of Tag structures

A list of tags on the resource.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • InternalServerError:

    A generic error indicating a server-side failure.

  • ResourceNotFound:

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

  • NotServiceResourceError:

    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.

  • ResourceDoesNotSupportTagging:

    The resource specified does not support tagging.

Examples

Example 1: To list tags for a resource

This operation lists tags for an Amazon FSx resource.

$result = $client->listTagsForResource([
    'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec',
]);

Result syntax:

[
    'Tags' => [
        [
            'Key' => 'Name',
            'Value' => 'MyFileSystem',
        ],
    ],
]

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Tags an Amazon FSx resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ResourceARN
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag.

Tags
  • Required: Yes
  • Type: Array of Tag structures

A list of tags for the resource. If a tag with a given key already exists, the value is replaced by the one specified in this parameter.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • InternalServerError:

    A generic error indicating a server-side failure.

  • ResourceNotFound:

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

  • NotServiceResourceError:

    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.

  • ResourceDoesNotSupportTagging:

    The resource specified does not support tagging.

Examples

Example 1: To tag a resource

This operation tags an Amazon FSx resource.

$result = $client->tagResource([
    'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec',
    'Tags' => [
        [
            'Key' => 'Name',
            'Value' => 'MyFileSystem',
        ],
    ],
]);

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

This action removes a tag from an Amazon FSx resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceARN
  • Required: Yes
  • Type: string

The ARN of the Amazon FSx resource to untag.

TagKeys
  • Required: Yes
  • Type: Array of strings

A list of keys of tags on the resource to untag. In case the tag key doesn't exist, the call will still succeed to be idempotent.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • InternalServerError:

    A generic error indicating a server-side failure.

  • ResourceNotFound:

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

  • NotServiceResourceError:

    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.

  • ResourceDoesNotSupportTagging:

    The resource specified does not support tagging.

Examples

Example 1: To untag a resource

This operation untags an Amazon FSx resource.

$result = $client->untagResource([
    'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec',
    'TagKeys' => [
        'Name',
    ],
]);

UpdateFileSystem

$result = $client->updateFileSystem([/* ... */]);
$promise = $client->updateFileSystemAsync([/* ... */]);

Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.

For Amazon FSx for Windows File Server file systems, you can update the following properties:

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • SelfManagedActiveDirectoryConfiguration

  • StorageCapacity

  • ThroughputCapacity

  • WeeklyMaintenanceStartTime

For Amazon FSx for Lustre file systems, you can update the following properties:

  • AutoImportPolicy

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • StorageCapacity

  • WeeklyMaintenanceStartTime

Parameter Syntax

$result = $client->updateFileSystem([
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
    'LustreConfiguration' => [
        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
        'AutomaticBackupRetentionDays' => <integer>,
        'DailyAutomaticBackupStartTime' => '<string>',
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'StorageCapacity' => <integer>,
    'WindowsConfiguration' => [
        'AutomaticBackupRetentionDays' => <integer>,
        'DailyAutomaticBackupStartTime' => '<string>',
        'SelfManagedActiveDirectoryConfiguration' => [
            'DnsIps' => ['<string>', ...],
            'Password' => '<string>',
            'UserName' => '<string>',
        ],
        'ThroughputCapacity' => <integer>,
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
]);

Parameter Details

Members
ClientRequestToken
  • Type: string

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

FileSystemId
  • Required: Yes
  • Type: string

Identifies the file system that you are updating.

LustreConfiguration
  • Type: UpdateFileSystemLustreConfiguration structure

The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.

StorageCapacity
  • Type: int

Use this parameter to increase the storage capacity of an Amazon FSx file system. Specifies the storage capacity target value, GiB, to increase the storage capacity for the file system that you're updating. You cannot make a storage capacity increase request if there is an existing storage capacity increase request in progress.

For Windows file systems, the storage capacity target value must be at least 10 percent (%) greater than the current storage capacity value. In order to increase storage capacity, the file system must have at least 16 MB/s of throughput capacity.

For Lustre file systems, the storage capacity target value can be the following:

  • For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.

  • For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for 12 MB/s/TiB file systems and multiples of 1800 GiB for 40 MB/s/TiB file systems. The values must be greater than the current storage capacity.

  • For SCRATCH_1 file systems, you cannot increase the storage capacity.

For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.

WindowsConfiguration
  • Type: UpdateFileSystemWindowsConfiguration structure

The configuration updates for an Amazon FSx for Windows File Server file system.

Result Syntax

[
    'FileSystem' => [
        'AdministrativeActions' => [
            [
                'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                'TargetFileSystemValues' => [...], // RECURSIVE
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING',
        'LustreConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DataRepositoryConfiguration' => [
                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
                'ExportPath' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING',
            ],
            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
            'DriveCacheType' => 'NONE|READ',
            'MountName' => '<string>',
            'PerUnitStorageThroughput' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<string>', ...],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'StorageType' => 'SSD|HDD',
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => '<string>',
            'Aliases' => [
                [
                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                    'Name' => '<string>',
                ],
                // ...
            ],
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
            'MaintenanceOperationsInProgress' => ['<string>', ...],
            'PreferredFileServerIp' => '<string>',
            'PreferredSubnetId' => '<string>',
            'RemoteAdministrationEndpoint' => '<string>',
            'SelfManagedActiveDirectoryConfiguration' => [
                'DnsIps' => ['<string>', ...],
                'DomainName' => '<string>',
                'FileSystemAdministratorsGroup' => '<string>',
                'OrganizationalUnitDistinguishedName' => '<string>',
                'UserName' => '<string>',
            ],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
    ],
]

Result Details

Members
FileSystem
  • Type: FileSystem structure

A description of the file system that was updated.

Errors

  • BadRequest:

    A generic error indicating a failure with a client request.

  • UnsupportedOperation:

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

  • IncompatibleParameterError:

    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.

  • InternalServerError:

    A generic error indicating a server-side failure.

  • FileSystemNotFound:

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

  • MissingFileSystemConfiguration:

    A file system configuration is required for this operation.

  • ServiceLimitExceeded:

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

Examples

Example 1: To update an existing file system

This operation updates an existing file system.

$result = $client->updateFileSystem([
    'FileSystemId' => 'fs-0498eed5fe91001ec',
    'WindowsConfiguration' => [
        'AutomaticBackupRetentionDays' => 10,
        'DailyAutomaticBackupStartTime' => '06:00',
        'WeeklyMaintenanceStartTime' => '3:06:00',
    ],
]);

Result syntax:

[
    'FileSystem' => [
        'CreationTime' => ,
        'DNSName' => 'fs-0498eed5fe91001ec.fsx.com',
        'FileSystemId' => 'fs-0498eed5fe91001ec',
        'KmsKeyId' => 'arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6',
        'Lifecycle' => 'AVAILABLE',
        'OwnerId' => '012345678912',
        'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec',
        'StorageCapacity' => 300,
        'SubnetIds' => [
            'subnet-1234abcd',
        ],
        'Tags' => [
            [
                'Key' => 'Name',
                'Value' => 'MyFileSystem',
            ],
        ],
        'VpcId' => 'vpc-ab1234cd',
        'WindowsConfiguration' => [
            'AutomaticBackupRetentionDays' => 10,
            'DailyAutomaticBackupStartTime' => '06:00',
            'ThroughputCapacity' => 8,
            'WeeklyMaintenanceStartTime' => '3:06:00',
        ],
    ],
]

Shapes

ActiveDirectoryBackupAttributes

Description

The Microsoft AD attributes of the Amazon FSx for Windows File Server file system.

Members
ActiveDirectoryId
  • Type: string

The ID of the AWS Managed Microsoft Active Directory instance to which the file system is joined.

DomainName
  • Type: string

The fully qualified domain name of the self-managed AD directory.

ActiveDirectoryError

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.

AdministrativeAction

Description

Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.

Members
AdministrativeActionType
  • Type: string

Describes the type of administrative action, as follows:

  • FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

  • STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts.

    • For Windows, storage optimization is the process of migrating the file system data to the new, larger disks.

    • For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

    You can track the storage optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.

  • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see .

  • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see .

FailureDetails
  • Type: AdministrativeActionFailureDetails structure

Provides information about a failed administrative action.

ProgressPercent
  • Type: int

Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.

RequestTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

Time that the administrative action request was received.

Status
  • Type: string

Describes the status of the administrative action, as follows:

  • FAILED - Amazon FSx failed to process the administrative action successfully.

  • IN_PROGRESS - Amazon FSx is processing the administrative action.

  • PENDING - Amazon FSx is waiting to process the administrative action.

  • COMPLETED - Amazon FSx has finished processing the administrative task.

  • UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage optimization process. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.

TargetFileSystemValues
  • Type: FileSystem structure

Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

AdministrativeActionFailureDetails

Description

Provides information about a failed administrative action.

Members
Message
  • Type: string

Error message providing details about the failed administrative action.

Alias

Description

A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the FSx for Windows File Server User Guide.

Members
Lifecycle
  • Type: string

Describes the state of the DNS alias.

  • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

  • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

  • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

  • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

  • DELETE_FAILED - Amazon FSx was unable to disassocate the DNS alias from the file system.

Name
  • Type: string

The name of the DNS alias. The alias name has to meet the following requirements:

  • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

  • Can contain alphanumeric characters and the hyphen (-).

  • Cannot start or end with a hyphen.

  • Can start with a numeric.

For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

Backup

Description

A backup of an Amazon FSx file system. For more information see:

  • Working with backups for Windows file systems

  • Working with backups for Lustre file systems

Members
BackupId
  • Required: Yes
  • Type: string

The ID of the backup.

CreationTime
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when a particular backup was created.

DirectoryInformation
  • Type: ActiveDirectoryBackupAttributes structure

The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.

FailureDetails
  • Type: BackupFailureDetails structure

Details explaining any failures that occur when creating a backup.

FileSystem
  • Required: Yes
  • Type: FileSystem structure

Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

KmsKeyId
  • Type: string

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.

Lifecycle
  • Required: Yes
  • Type: string

The lifecycle status of the backup.

  • AVAILABLE - The backup is fully available.

  • PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.

  • CREATING - Amazon FSx is creating the backup.

  • TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to S3.

  • DELETED - Amazon FSx deleted the backup and it is no longer available.

  • FAILED - Amazon FSx could not complete the backup.

ProgressPercent
  • Type: int

The current percent of progress of an asynchronous task.

ResourceARN
  • Type: string

The Amazon Resource Name (ARN) for the backup resource.

Tags
  • Type: Array of Tag structures

Tags associated with a particular file system.

Type
  • Required: Yes
  • Type: string

The type of the file system backup.

BackupFailureDetails

Description

If backup creation fails, this structure contains the details of that failure.

Members
Message
  • Type: string

A message describing the backup creation failure.

BackupInProgress

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

Description

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

Members
Message
  • Type: string

A detailed error message.

BackupRestoring

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

Description

A generic error indicating a failure with a client request.

Members
Message
  • Type: string

A detailed error message.

CompletionReport

Description

Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report Scope parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report Path parameter. You can specify whether or not a report gets generated for a task using the Enabled parameter.

Members
Enabled
  • Required: Yes
  • Type: boolean

Set Enabled to True to generate a CompletionReport when the task completes. If set to true, then you need to provide a report Scope, Path, and Format. Set Enabled to False if you do not want a CompletionReport generated when the task completes.

Format
  • Type: string

Required if Enabled is set to true. Specifies the format of the CompletionReport. REPORT_CSV_20191124 is the only format currently supported. When Format is set to REPORT_CSV_20191124, the CompletionReport is provided in CSV format, and is delivered to {path}/task-{id}/failures.csv.

Path
  • Type: string

Required if Enabled is set to true. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The Path you provide must be located within the file system’s ExportPath. An example Path value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode. To learn more about a file system's ExportPath, see .

Scope
  • Type: string

Required if Enabled is set to true. Specifies the scope of the CompletionReport; FAILED_FILES_ONLY is the only scope currently supported. When Scope is set to FAILED_FILES_ONLY, the CompletionReport only contains information about files that the data repository task failed to process.

CreateFileSystemLustreConfiguration

Description

The Lustre configuration for the file system being created.

Members
AutoImportPolicy
  • Type: string

(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

  • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

  • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

  • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

For more information, see Automatically import updates from your S3 bucket.

AutomaticBackupRetentionDays
  • Type: int

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.

CopyTagsToBackups
  • Type: boolean

(Optional) Not available to use with file systems that are linked to a data repository. A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. If it's set to true, all file system tags are copied to all automatic and user-initiated backups when the user doesn't specify any backup-specific tags. If this value is true, and you specify one or more backup tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

For more information, see Working with backups.

DailyAutomaticBackupStartTime
  • Type: string

A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

DeploymentType
  • Type: string

Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

Choose PERSISTENT_1 deployment type for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options.

Encryption of data in-transit is automatically enabled when you access a SCRATCH_2 or PERSISTENT_1 file system from Amazon EC2 instances that support this feature. (Default = SCRATCH_1)

Encryption of data in-transit for SCRATCH_2 and PERSISTENT_1 deployment types is supported when accessed from supported instance types in supported AWS Regions. To learn more, Encrypting Data in Transit.

DriveCacheType
  • Type: string

The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set to READ, improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached.

This parameter is required when StorageType is set to HDD.

ExportPath
  • Type: string

(Optional) The path in Amazon S3 where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z.

The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath. If you only specify a bucket name, such as s3://import-bucket, you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket.

ImportPath
  • Type: string

(Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

ImportedFileChunkSize
  • Type: int

(Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

PerUnitStorageThroughput
  • Type: int

Required for the PERSISTENT_1 deployment type, describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4 TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision.

Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.

WeeklyMaintenanceStartTime
  • Type: string

(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

CreateFileSystemWindowsConfiguration

Description

The configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup operations.

Members
ActiveDirectoryId
  • Type: string

The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.

Aliases
  • Type: Array of strings

An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload.

For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

An alias name has to meet the following requirements:

  • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

  • Can contain alphanumeric characters and the hyphen (-).

  • Cannot start or end with a hyphen.

  • Can start with a numeric.

For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

AutomaticBackupRetentionDays
  • Type: int

The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 90 days.

CopyTagsToBackups
  • Type: boolean

A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

DailyAutomaticBackupStartTime
  • Type: string

The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.

DeploymentType
  • Type: string

Specifies the file system deployment type, valid values are the following:

  • MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones. Also supports HDD storage type

  • SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.

  • SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.

For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems.

PreferredSubnetId
  • Type: string

Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located. For in-AWS applications, we recommend that you launch your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs and minimize latency.

SelfManagedActiveDirectoryConfiguration
  • Type: SelfManagedActiveDirectoryConfiguration structure

The configuration that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.

ThroughputCapacity
  • Required: Yes
  • Type: int

The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).

WeeklyMaintenanceStartTime
  • Type: string

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

DataRepositoryConfiguration

Description

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

Members
AutoImportPolicy
  • Type: string

Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

  • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

  • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

  • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

For more information, see Automatically import updates from your S3 bucket.

ExportPath
  • Type: string

The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

FailureDetails
  • Type: DataRepositoryFailureDetails structure

Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED.

ImportPath
  • Type: string

The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

ImportedFileChunkSize
  • Type: int

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

Lifecycle
  • Type: string

Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

  • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

  • AVAILABLE - The data repository is available for use.

  • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

  • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

DataRepositoryFailureDetails

Description

Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED.

Members
Message
  • Type: string

A detailed error message.

DataRepositoryTask

Description

A description of the data repository task. You use data repository tasks to perform bulk transfer operations between your Amazon FSx file system and its linked data repository.

Members
CreationTime
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

EndTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that Amazon FSx completed processing the task, populated after the task is complete.

FailureDetails
  • Type: DataRepositoryTaskFailureDetails structure

Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED.

FileSystemId
  • Required: Yes
  • Type: string

The globally unique ID of the file system, assigned by Amazon FSx.

Lifecycle
  • Required: Yes
  • Type: string

The lifecycle status of the data repository task, as follows:

  • PENDING - Amazon FSx has not started the task.

  • EXECUTING - Amazon FSx is processing the task.

  • FAILED - Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.

  • SUCCEEDED - FSx completed the task successfully.

  • CANCELED - Amazon FSx canceled the task and it did not complete.

  • CANCELING - FSx is in process of canceling the task.

You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the PENDING or EXECUTING states. Please retry when the data repository task is finished (with a status of CANCELED, SUCCEEDED, or FAILED). You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.

Paths
  • Type: Array of strings

An array of paths on the Amazon FSx for Lustre file system that specify the data for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.

(Default) If Paths is not specified, Amazon FSx uses the file system root directory.

Report
  • Type: CompletionReport structure

Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report Scope parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report Path parameter. You can specify whether or not a report gets generated for a task using the Enabled parameter.

ResourceARN
  • Type: string

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify AWS resources. We require an ARN when you need to specify a resource unambiguously across all of AWS. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

StartTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that Amazon FSx began processing the task.

Status
  • Type: DataRepositoryTaskStatus structure

Provides the status of the number of files that the task has processed successfully and failed to process.

Tags
  • Type: Array of Tag structures

A list of Tag values, with a maximum of 50 elements.

TaskId
  • Required: Yes
  • Type: string

The system-generated, unique 17-digit ID of the data repository task.

Type
  • Required: Yes
  • Type: string

The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.

DataRepositoryTaskEnded

Description

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

Members
Message
  • Type: string

A detailed error message.

DataRepositoryTaskExecuting

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.

DataRepositoryTaskFailureDetails

Description

Provides information about why a data repository task failed. Only populated when the task Lifecycle is set to FAILED.

Members
Message
  • Type: string

A detailed error message.

DataRepositoryTaskFilter

Description

(Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the the response. You can filter the tasks returned in the response by one or more file system IDs, task lifecycles, and by task type. A filter object consists of a filter Name, and one or more Values for the filter.

Members
Name
  • Type: string

Name of the task property to use in filtering the tasks returned in the response.

  • Use file-system-id to retrieve data repository tasks for specific file systems.

  • Use task-lifecycle to retrieve data repository tasks with one or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.

Values
  • Type: Array of strings

Use Values to include the specific file system IDs and task lifecycle states for the filters you are using.

DataRepositoryTaskNotFound

Description

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

Members
Message
  • Type: string

A detailed error message.

DataRepositoryTaskStatus

Description

Provides the task status showing a running total of the total number of files to be processed, the number successfully processed, and the number of files the task failed to process.

Members
FailedCount
  • Type: long (int|float)

A running total of the number of files that the task failed to process.

LastUpdatedTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the task status was last updated.

SucceededCount
  • Type: long (int|float)

A running total of the number of files that the task has successfully processed.

TotalCount
  • Type: long (int|float)

The total number of files that the task will process. While a task is executing, the sum of SucceededCount plus FailedCount may not equal TotalCount. When the task is complete, TotalCount equals the sum of SucceededCount plus FailedCount.

DeleteFileSystemLustreConfiguration

Description

The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

Members
FinalBackupTags
  • Type: Array of Tag structures

Use if SkipFinalBackup is set to false, and you want to apply an array of tags to the final backup. If you have set the file system property CopyTagsToBackups to true, and you specify one or more FinalBackupTags when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup.

SkipFinalBackup
  • Type: boolean

Set SkipFinalBackup to false if you want to take a final backup of the file system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the DeleteFileSystem operation is invoked. (Default = true)

DeleteFileSystemLustreResponse

Description

The response object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

Members
FinalBackupId
  • Type: string

The ID of the final backup for this file system.

FinalBackupTags
  • Type: Array of Tag structures

The set of tags applied to the final backup.

DeleteFileSystemWindowsConfiguration

Description

The configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation.

Members
FinalBackupTags
  • Type: Array of Tag structures

A set of tags for your final backup.

SkipFinalBackup
  • Type: boolean

By default, Amazon FSx for Windows takes a final backup on your behalf when the DeleteFileSystem operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip this backup, use this flag to do so.

DeleteFileSystemWindowsResponse

Description

The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.

Members
FinalBackupId
  • Type: string

The ID of the final backup for this file system.

FinalBackupTags
  • Type: Array of Tag structures

The set of tags applied to the final backup.

FileSystem

Description

A description of a specific Amazon FSx file system.

Members
AdministrativeActions
  • Type: Array of AdministrativeAction structures

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Windows file system that you have initiated using the UpdateFileSystem action.

CreationTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

DNSName
  • Type: string

The DNS name for the file system.

FailureDetails
  • Type: FileSystemFailureDetails structure

A structure providing details of any failures that occur when creating the file system has failed.

FileSystemId
  • Type: string

The system-generated, unique 17-digit ID of the file system.

FileSystemType
  • Type: string

The type of Amazon FSx file system, either LUSTRE or WINDOWS.

KmsKeyId
  • Type: string

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference.

Lifecycle
  • Type: string

The lifecycle status of the file system, following are the possible values and what they mean:

  • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

  • CREATING - Amazon FSx is creating the new file system.

  • DELETING - Amazon FSx is deleting an existing file system.

  • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

  • MISCONFIGURED indicates that the file system is in a failed but recoverable state.

  • UPDATING indicates that the file system is undergoing a customer initiated update.

LustreConfiguration
  • Type: LustreFileSystemConfiguration structure

The configuration for the Amazon FSx for Lustre file system.

NetworkInterfaceIds
  • Type: Array of strings

The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

OwnerId
  • Type: string

The AWS account that created the file system. If the file system was created by an AWS Identity and Access Management (IAM) user, the AWS account to which the IAM user belongs is the owner.

ResourceARN
  • Type: string

The Amazon Resource Name (ARN) for the file system resource.

StorageCapacity
  • Type: int

The storage capacity of the file system in gibibytes (GiB).

StorageType
  • Type: string

The storage type of the file system. Valid values are SSD and HDD. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

SubnetIds
  • Type: Array of strings

Specifies the IDs of the subnets that the file system is accessible from. For Windows MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

For Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file system is available in the PreferredSubnetID.

Tags
  • Type: Array of Tag structures

The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

VpcId
  • Type: string

The ID of the primary VPC for the file system.

WindowsConfiguration
  • Type: WindowsFileSystemConfiguration structure

The configuration for this Microsoft Windows file system.

FileSystemFailureDetails

Description

A structure providing details of any failures that occur when creating the file system has failed.

Members
Message
  • Type: string

A message describing any failures that occurred during file system creation.

FileSystemNotFound

Description

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

Members
Message
  • Type: string

A detailed error message.

Filter

Description

A filter used to restrict the results of describe calls. You can use multiple filters to return results that meet all applied filter requirements.

Members
Name
  • Type: string

The name for this filter.

Values
  • Type: Array of strings

The values of the filter. These are all the values for any of the applied filters.

IncompatibleParameterError

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.

InternalServerError

Description

A generic error indicating a server-side failure.

Members
Message
  • Type: string

A detailed error message.

InvalidExportPath

Description

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

Members
Message
  • Type: string

A detailed error message.

InvalidImportPath

Description

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

Members
Message
  • Type: string

A detailed error message.

InvalidNetworkSettings

Description

One or more network settings specified in the request are invalid. InvalidVpcId means that the ID passed for the virtual private cloud (VPC) is invalid. InvalidSubnetIds returns the list of IDs for subnets that are either invalid or not part of the VPC specified. InvalidSecurityGroupIds returns the list of IDs for security groups that are either invalid or not part of the VPC specified.

Members
InvalidSecurityGroupId
  • Type: string

The ID of your Amazon EC2 security group. This ID is used to control network access to the endpoint that Amazon FSx creates on your behalf in each subnet. For more information, see Amazon EC2 Security Groups for Linux Instances in the Amazon EC2 User Guide.

InvalidSubnetId
  • Type: string

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.

Message
  • Type: string

A detailed error message.

InvalidPerUnitStorageThroughput

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.

LustreFileSystemConfiguration

Description

The configuration for the Amazon FSx for Lustre file system.

Members
AutomaticBackupRetentionDays
  • Type: int

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.

CopyTagsToBackups
  • Type: boolean

A boolean flag indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

DailyAutomaticBackupStartTime
  • Type: string

A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

DataRepositoryConfiguration
  • Type: DataRepositoryConfiguration structure

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

DeploymentType
  • Type: string

The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

The PERSISTENT_1 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options. (Default = SCRATCH_1)

DriveCacheType
  • Type: string

The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set to READ, improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached.

This parameter is required when StorageType is set to HDD.

MountName
  • Type: string

You use the MountName value when mounting the file system.

For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2 and PERSISTENT_1 deployment types, this value is a string that is unique within an AWS Region.

PerUnitStorageThroughput
  • Type: int

Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 deployment types.

Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.

WeeklyMaintenanceStartTime
  • Type: string

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

MissingFileSystemConfiguration

Description

A file system configuration is required for this operation.

Members
Message
  • Type: string

A detailed error message.

NotServiceResourceError

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

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

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.

SelfManagedActiveDirectoryAttributes

Description

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server instance is joined.

Members
DnsIps
  • Type: Array of strings

A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.

DomainName
  • Type: string

The fully qualified domain name of the self-managed AD directory.

FileSystemAdministratorsGroup
  • Type: string

The name of the domain group whose members have administrative privileges for the FSx file system.

OrganizationalUnitDistinguishedName
  • Type: string

The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server instance is joined.

UserName
  • Type: string

The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

SelfManagedActiveDirectoryConfiguration

Description

The configuration that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.

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

A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being created, or in the private IP version 4 (IPv4) address ranges, as specified in RFC 1918:

  • 10.0.0.0 - 10.255.255.255 (10/8 prefix)

  • 172.16.0.0 - 172.31.255.255 (172.16/12 prefix)

  • 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)

DomainName
  • Required: Yes
  • Type: string

The fully qualified domain name of the self-managed AD directory, such as corp.example.com.

FileSystemAdministratorsGroup
  • Type: string

(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.

OrganizationalUnitDistinguishedName
  • Type: string

(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory.

Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.

Password
  • Required: Yes
  • Type: string

The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

UserName
  • Required: Yes
  • Type: string

The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName, or in the default location of your AD domain.

SelfManagedActiveDirectoryConfigurationUpdates

Description

The configuration that Amazon FSx uses to join the Windows File Server instance to a self-managed Microsoft Active Directory (AD) directory.

Members
DnsIps
  • Type: Array of strings

A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.

Password
  • Type: string

The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

UserName
  • Type: string

The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName.

ServiceLimitExceeded

Description

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

Members
Limit
  • Required: Yes
  • Type: string

Enumeration of the service limit that was exceeded.

Message
  • Type: string

A detailed error message.

Tag

Description

Specifies a key-value pair for a resource tag.

Members
Key
  • Required: Yes
  • Type: string

A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

Value
  • Required: Yes
  • Type: string

A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

UnsupportedOperation

Description

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

Members
Message
  • Type: string

A detailed error message.

UpdateFileSystemLustreConfiguration

Description

The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.

Members
AutoImportPolicy
  • Type: string

(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listing up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

  • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update the file and directory listing for any new or changed objects after choosing this option.

  • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

  • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

For more information, see Automatically import updates from your S3 bucket.

AutomaticBackupRetentionDays
  • Type: int

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.

DailyAutomaticBackupStartTime
  • Type: string

A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

WeeklyMaintenanceStartTime
  • Type: string

(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

UpdateFileSystemWindowsConfiguration

Description

Updates the configuration for an existing Amazon FSx for Windows File Server file system. Amazon FSx only overwrites existing properties with non-null values provided in the request.

Members
AutomaticBackupRetentionDays
  • Type: int

The number of days to retain automatic daily backups. Setting this to zero (0) disables automatic daily backups. You can retain automatic daily backups for a maximum of 90 days. For more information, see Working with Automatic Daily Backups.

DailyAutomaticBackupStartTime
  • Type: string

The preferred time to start the daily automatic backup, in the UTC time zone, for example, 02:00

SelfManagedActiveDirectoryConfiguration
  • Type: SelfManagedActiveDirectoryConfigurationUpdates structure

The configuration Amazon FSx uses to join the Windows File Server instance to the self-managed Microsoft AD directory. You cannot make a self-managed Microsoft AD update request if there is an existing self-managed Microsoft AD update request in progress.

ThroughputCapacity
  • Type: int

Sets the target value for a file system's throughput capacity, in MB/s, that you are updating the file system to. Valid values are 8, 16, 32, 64, 128, 256, 512, 1024, 2048. You cannot make a throughput capacity update request if there is an existing throughput capacity update request in progress. For more information, see Managing Throughput Capacity.

WeeklyMaintenanceStartTime
  • Type: string

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Where d is the weekday number, from 1 through 7, with 1 = Monday and 7 = Sunday.

WindowsFileSystemConfiguration

Description

The configuration for this Microsoft Windows file system.

Members
ActiveDirectoryId
  • Type: string

The ID for an existing Microsoft Active Directory instance that the file system should join when it's created.

Aliases
  • Type: Array of Alias structures

An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases.

AutomaticBackupRetentionDays
  • Type: int

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.

CopyTagsToBackups
  • Type: boolean

A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

DailyAutomaticBackupStartTime
  • Type: string

The preferred time to take daily automatic backups, in the UTC time zone.

DeploymentType
  • Type: string

Specifies the file system deployment type, valid values are the following:

  • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

  • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

  • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

For more information, see Single-AZ and Multi-AZ File Systems.

MaintenanceOperationsInProgress
  • Type: Array of strings

The list of maintenance operations in progress for this file system.

PreferredFileServerIp
  • Type: string

For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.

PreferredSubnetId
  • Type: string

For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems

RemoteAdministrationEndpoint
  • Type: string

For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

This endpoint is temporarily unavailable when the file system is undergoing maintenance.

SelfManagedActiveDirectoryConfiguration
  • Type: SelfManagedActiveDirectoryAttributes structure

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server instance is joined.

ThroughputCapacity
  • Type: int

The throughput of an Amazon FSx file system, measured in megabytes per second.

WeeklyMaintenanceStartTime
  • Type: string

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

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