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

Namespaces

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

Classes

  • Aws\AbstractConfigurationProvider
  • Aws\AccessAnalyzer\AccessAnalyzerClient
  • Aws\Account\AccountClient
  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Amplify\AmplifyClient
  • Aws\AmplifyBackend\AmplifyBackendClient
  • Aws\AmplifyUIBuilder\AmplifyUIBuilderClient
  • 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\AppConfigData\AppConfigDataClient
  • Aws\Appflow\AppflowClient
  • Aws\AppIntegrationsService\AppIntegrationsServiceClient
  • Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationCostProfiler\ApplicationCostProfilerClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\ApplicationInsights\ApplicationInsightsClient
  • Aws\AppMesh\AppMeshClient
  • Aws\AppRegistry\AppRegistryClient
  • Aws\AppRunner\AppRunnerClient
  • Aws\Appstream\AppstreamClient
  • Aws\AppSync\AppSyncClient
  • Aws\ARCZonalShift\ARCZonalShiftClient
  • Aws\Athena\AthenaClient
  • Aws\AuditManager\AuditManagerClient
  • Aws\AugmentedAIRuntime\AugmentedAIRuntimeClient
  • Aws\AutoScaling\AutoScalingClient
  • Aws\AutoScalingPlans\AutoScalingPlansClient
  • Aws\AwsClient
  • Aws\Backup\BackupClient
  • Aws\BackupGateway\BackupGatewayClient
  • Aws\BackupStorage\BackupStorageClient
  • Aws\Batch\BatchClient
  • Aws\BillingConductor\BillingConductorClient
  • Aws\Braket\BraketClient
  • Aws\Budgets\BudgetsClient
  • Aws\Chime\ChimeClient
  • Aws\ChimeSDKIdentity\ChimeSDKIdentityClient
  • Aws\ChimeSDKMediaPipelines\ChimeSDKMediaPipelinesClient
  • Aws\ChimeSDKMeetings\ChimeSDKMeetingsClient
  • Aws\ChimeSDKMessaging\ChimeSDKMessagingClient
  • Aws\ChimeSDKVoice\ChimeSDKVoiceClient
  • Aws\CleanRooms\CleanRoomsClient
  • Aws\ClientResolver
  • Aws\ClientSideMonitoring\Configuration
  • Aws\ClientSideMonitoring\ConfigurationProvider
  • Aws\Cloud9\Cloud9Client
  • Aws\CloudControlApi\CloudControlApiClient
  • 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\CloudTrailData\CloudTrailDataClient
  • Aws\CloudWatch\CloudWatchClient
  • Aws\CloudWatchEvents\CloudWatchEventsClient
  • Aws\CloudWatchEvidently\CloudWatchEvidentlyClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CloudWatchRUM\CloudWatchRUMClient
  • Aws\CodeArtifact\CodeArtifactClient
  • Aws\CodeBuild\CodeBuildClient
  • Aws\CodeCatalyst\CodeCatalystClient
  • 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\ConnectCampaignService\ConnectCampaignServiceClient
  • Aws\ConnectCases\ConnectCasesClient
  • Aws\ConnectContactLens\ConnectContactLensClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • Aws\ConnectWisdomService\ConnectWisdomServiceClient
  • Aws\ControlTower\ControlTowerClient
  • 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\DefaultsMode\Configuration
  • Aws\DefaultsMode\ConfigurationProvider
  • Aws\Detective\DetectiveClient
  • Aws\DeviceFarm\DeviceFarmClient
  • Aws\DevOpsGuru\DevOpsGuruClient
  • Aws\DirectConnect\DirectConnectClient
  • Aws\DirectoryService\DirectoryServiceClient
  • Aws\DLM\DLMClient
  • Aws\DocDB\DocDBClient
  • Aws\DocDBElastic\DocDBElasticClient
  • Aws\DoctrineCacheAdapter
  • Aws\drs\drsClient
  • 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\EMRServerless\EMRServerlessClient
  • Aws\Endpoint\EndpointProvider
  • Aws\Endpoint\Partition
  • Aws\Endpoint\PartitionEndpointProvider
  • Aws\Endpoint\PatternEndpointProvider
  • Aws\Endpoint\UseDualstackEndpoint\Configuration
  • Aws\Endpoint\UseDualstackEndpoint\ConfigurationProvider
  • Aws\Endpoint\UseFipsEndpoint\Configuration
  • Aws\Endpoint\UseFipsEndpoint\ConfigurationProvider
  • Aws\EndpointDiscovery\Configuration
  • Aws\EndpointDiscovery\ConfigurationProvider
  • Aws\EndpointDiscovery\EndpointDiscoveryMiddleware
  • Aws\EndpointDiscovery\EndpointList
  • Aws\EndpointV2\EndpointDefinitionProvider
  • Aws\EndpointV2\EndpointProviderV2
  • Aws\EndpointV2\Rule\AbstractRule
  • Aws\EndpointV2\Rule\EndpointRule
  • Aws\EndpointV2\Rule\ErrorRule
  • Aws\EndpointV2\Rule\RuleCreator
  • Aws\EndpointV2\Rule\TreeRule
  • Aws\EndpointV2\Ruleset\Ruleset
  • Aws\EndpointV2\Ruleset\RulesetEndpoint
  • Aws\EndpointV2\Ruleset\RulesetParameter
  • Aws\EventBridge\EventBridgeClient
  • Aws\finspace\finspaceClient
  • Aws\FinSpaceData\FinSpaceDataClient
  • Aws\Firehose\FirehoseClient
  • Aws\FIS\FISClient
  • Aws\FMS\FMSClient
  • Aws\ForecastQueryService\ForecastQueryServiceClient
  • Aws\ForecastService\ForecastServiceClient
  • Aws\FraudDetector\FraudDetectorClient
  • Aws\FSx\FSxClient
  • Aws\GameLift\GameLiftClient
  • Aws\GameSparks\GameSparksClient
  • 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\Inspector2\Inspector2Client
  • Aws\Inspector\InspectorClient
  • Aws\InternetMonitor\InternetMonitorClient
  • 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\IoTFleetWise\IoTFleetWiseClient
  • Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
  • Aws\IoTRoboRunner\IoTRoboRunnerClient
  • Aws\IoTSecureTunneling\IoTSecureTunnelingClient
  • Aws\IoTSiteWise\IoTSiteWiseClient
  • Aws\IoTThingsGraph\IoTThingsGraphClient
  • Aws\IoTTwinMaker\IoTTwinMakerClient
  • Aws\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\ivschat\ivschatClient
  • Aws\IVSRealTime\IVSRealTimeClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\KafkaConnect\KafkaConnectClient
  • Aws\kendra\kendraClient
  • Aws\KendraRanking\KendraRankingClient
  • Aws\Keyspaces\KeyspacesClient
  • Aws\Kinesis\KinesisClient
  • Aws\KinesisAnalytics\KinesisAnalyticsClient
  • Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client
  • Aws\KinesisVideo\KinesisVideoClient
  • Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient
  • Aws\KinesisVideoMedia\KinesisVideoMediaClient
  • Aws\KinesisVideoSignalingChannels\KinesisVideoSignalingChannelsClient
  • Aws\KinesisVideoWebRTCStorage\KinesisVideoWebRTCStorageClient
  • 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\LicenseManagerLinuxSubscriptions\LicenseManagerLinuxSubscriptionsClient
  • Aws\LicenseManagerUserSubscriptions\LicenseManagerUserSubscriptionsClient
  • Aws\Lightsail\LightsailClient
  • Aws\LocationService\LocationServiceClient
  • Aws\LookoutEquipment\LookoutEquipmentClient
  • Aws\LookoutforVision\LookoutforVisionClient
  • Aws\LookoutMetrics\LookoutMetricsClient
  • Aws\LruArrayCache
  • Aws\MachineLearning\MachineLearningClient
  • Aws\Macie2\Macie2Client
  • Aws\Macie\MacieClient
  • Aws\MainframeModernization\MainframeModernizationClient
  • Aws\ManagedBlockchain\ManagedBlockchainClient
  • Aws\ManagedGrafana\ManagedGrafanaClient
  • 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\MemoryDB\MemoryDBClient
  • Aws\mgn\mgnClient
  • Aws\Middleware
  • Aws\MigrationHub\MigrationHubClient
  • Aws\MigrationHubConfig\MigrationHubConfigClient
  • Aws\MigrationHubOrchestrator\MigrationHubOrchestratorClient
  • Aws\MigrationHubRefactorSpaces\MigrationHubRefactorSpacesClient
  • Aws\MigrationHubStrategyRecommendations\MigrationHubStrategyRecommendationsClient
  • 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\NimbleStudio\NimbleStudioClient
  • Aws\OAM\OAMClient
  • Aws\Omics\OmicsClient
  • Aws\OpenSearchServerless\OpenSearchServerlessClient
  • Aws\OpenSearchService\OpenSearchServiceClient
  • Aws\OpsWorks\OpsWorksClient
  • Aws\OpsWorksCM\OpsWorksCMClient
  • Aws\Organizations\OrganizationsClient
  • Aws\Outposts\OutpostsClient
  • Aws\Panorama\PanoramaClient
  • Aws\Personalize\PersonalizeClient
  • Aws\PersonalizeEvents\PersonalizeEventsClient
  • Aws\PersonalizeRuntime\PersonalizeRuntimeClient
  • Aws\PhpHash
  • Aws\PI\PIClient
  • Aws\Pinpoint\PinpointClient
  • Aws\PinpointEmail\PinpointEmailClient
  • Aws\PinpointSMSVoice\PinpointSMSVoiceClient
  • Aws\PinpointSMSVoiceV2\PinpointSMSVoiceV2Client
  • Aws\Pipes\PipesClient
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\PrivateNetworks\PrivateNetworksClient
  • Aws\PrometheusService\PrometheusServiceClient
  • Aws\Proton\ProtonClient
  • 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\RecycleBin\RecycleBinClient
  • Aws\Redshift\RedshiftClient
  • Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
  • Aws\RedshiftServerless\RedshiftServerlessClient
  • Aws\Rekognition\RekognitionClient
  • Aws\ResilienceHub\ResilienceHubClient
  • Aws\ResourceExplorer2\ResourceExplorer2Client
  • Aws\ResourceGroups\ResourceGroupsClient
  • Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
  • Aws\Result
  • Aws\ResultPaginator
  • Aws\Retry\Configuration
  • Aws\Retry\ConfigurationProvider
  • Aws\RoboMaker\RoboMakerClient
  • Aws\RolesAnywhere\RolesAnywhereClient
  • Aws\Route53\Route53Client
  • Aws\Route53Domains\Route53DomainsClient
  • Aws\Route53RecoveryCluster\Route53RecoveryClusterClient
  • Aws\Route53RecoveryControlConfig\Route53RecoveryControlConfigClient
  • Aws\Route53RecoveryReadiness\Route53RecoveryReadinessClient
  • 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\S3\ValidateResponseChecksumParser
  • Aws\S3Control\S3ControlClient
  • Aws\S3Outposts\S3OutpostsClient
  • Aws\SageMaker\SageMakerClient
  • Aws\SagemakerEdgeManager\SagemakerEdgeManagerClient
  • Aws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient
  • Aws\SageMakerGeospatial\SageMakerGeospatialClient
  • Aws\SageMakerMetrics\SageMakerMetricsClient
  • Aws\SageMakerRuntime\SageMakerRuntimeClient
  • Aws\SavingsPlans\SavingsPlansClient
  • Aws\Scheduler\SchedulerClient
  • Aws\Schemas\SchemasClient
  • Aws\Script\Composer\Composer
  • Aws\Sdk
  • Aws\SecretsManager\SecretsManagerClient
  • Aws\SecurityHub\SecurityHubClient
  • Aws\SecurityLake\SecurityLakeClient
  • 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\SimSpaceWeaver\SimSpaceWeaverClient
  • Aws\Sms\SmsClient
  • Aws\SnowBall\SnowBallClient
  • Aws\SnowDeviceManagement\SnowDeviceManagementClient
  • Aws\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • Aws\SSMContacts\SSMContactsClient
  • Aws\SSMIncidents\SSMIncidentsClient
  • Aws\SsmSap\SsmSapClient
  • 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\SupportApp\SupportAppClient
  • Aws\Swf\SwfClient
  • Aws\Synthetics\SyntheticsClient
  • Aws\Textract\TextractClient
  • Aws\TimestreamQuery\TimestreamQueryClient
  • Aws\TimestreamWrite\TimestreamWriteClient
  • Aws\Tnb\TnbClient
  • Aws\Token\BearerTokenAuthorization
  • Aws\Token\SsoToken
  • Aws\Token\SsoTokenProvider
  • Aws\Token\Token
  • Aws\Token\TokenProvider
  • Aws\TraceMiddleware
  • Aws\TranscribeService\TranscribeServiceClient
  • Aws\Transfer\TransferClient
  • Aws\Translate\TranslateClient
  • Aws\VoiceID\VoiceIDClient
  • 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\WorkSpacesWeb\WorkSpacesWebClient
  • 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\DefaultsMode\ConfigurationInterface
  • Aws\DynamoDb\SessionConnectionInterface
  • Aws\Endpoint\PartitionInterface
  • Aws\Endpoint\UseDualstackEndpoint\ConfigurationInterface
  • Aws\Endpoint\UseFipsEndpoint\ConfigurationInterface
  • 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
  • Aws\Token\RefreshableTokenProviderInterface
  • Aws\Token\TokenAuthorization
  • Aws\Token\TokenInterface

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\CalculatesChecksumTrait
  • Aws\S3\Crypto\CryptoParamsTrait
  • Aws\S3\Crypto\CryptoParamsTraitV2
  • Aws\S3\Crypto\UserAgentTrait
  • Aws\S3\MultipartUploadingTrait
  • Aws\S3\S3ClientTrait
  • Aws\Signature\SignatureTrait
  • Aws\Token\ParsesIniTrait

Exceptions

  • Aws\AccessAnalyzer\Exception\AccessAnalyzerException
  • Aws\Account\Exception\AccountException
  • Aws\Acm\Exception\AcmException
  • Aws\ACMPCA\Exception\ACMPCAException
  • Aws\AlexaForBusiness\Exception\AlexaForBusinessException
  • Aws\Amplify\Exception\AmplifyException
  • Aws\AmplifyBackend\Exception\AmplifyBackendException
  • Aws\AmplifyUIBuilder\Exception\AmplifyUIBuilderException
  • Aws\Api\Parser\Exception\ParserException
  • Aws\ApiGateway\Exception\ApiGatewayException
  • Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException
  • Aws\ApiGatewayV2\Exception\ApiGatewayV2Exception
  • Aws\AppConfig\Exception\AppConfigException
  • Aws\AppConfigData\Exception\AppConfigDataException
  • Aws\Appflow\Exception\AppflowException
  • Aws\AppIntegrationsService\Exception\AppIntegrationsServiceException
  • Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException
  • Aws\ApplicationCostProfiler\Exception\ApplicationCostProfilerException
  • Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException
  • Aws\ApplicationInsights\Exception\ApplicationInsightsException
  • Aws\AppMesh\Exception\AppMeshException
  • Aws\AppRegistry\Exception\AppRegistryException
  • Aws\AppRunner\Exception\AppRunnerException
  • Aws\Appstream\Exception\AppstreamException
  • Aws\AppSync\Exception\AppSyncException
  • Aws\ARCZonalShift\Exception\ARCZonalShiftException
  • 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\BackupGateway\Exception\BackupGatewayException
  • Aws\BackupStorage\Exception\BackupStorageException
  • Aws\Batch\Exception\BatchException
  • Aws\BillingConductor\Exception\BillingConductorException
  • Aws\Braket\Exception\BraketException
  • Aws\Budgets\Exception\BudgetsException
  • Aws\Chime\Exception\ChimeException
  • Aws\ChimeSDKIdentity\Exception\ChimeSDKIdentityException
  • Aws\ChimeSDKMediaPipelines\Exception\ChimeSDKMediaPipelinesException
  • Aws\ChimeSDKMeetings\Exception\ChimeSDKMeetingsException
  • Aws\ChimeSDKMessaging\Exception\ChimeSDKMessagingException
  • Aws\ChimeSDKVoice\Exception\ChimeSDKVoiceException
  • Aws\CleanRooms\Exception\CleanRoomsException
  • Aws\ClientSideMonitoring\Exception\ConfigurationException
  • Aws\Cloud9\Exception\Cloud9Exception
  • Aws\CloudControlApi\Exception\CloudControlApiException
  • 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\CloudTrailData\Exception\CloudTrailDataException
  • Aws\CloudWatch\Exception\CloudWatchException
  • Aws\CloudWatchEvents\Exception\CloudWatchEventsException
  • Aws\CloudWatchEvidently\Exception\CloudWatchEvidentlyException
  • Aws\CloudWatchLogs\Exception\CloudWatchLogsException
  • Aws\CloudWatchRUM\Exception\CloudWatchRUMException
  • Aws\CodeArtifact\Exception\CodeArtifactException
  • Aws\CodeBuild\Exception\CodeBuildException
  • Aws\CodeCatalyst\Exception\CodeCatalystException
  • 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\ConnectCampaignService\Exception\ConnectCampaignServiceException
  • Aws\ConnectCases\Exception\ConnectCasesException
  • Aws\ConnectContactLens\Exception\ConnectContactLensException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • Aws\ConnectWisdomService\Exception\ConnectWisdomServiceException
  • Aws\ControlTower\Exception\ControlTowerException
  • 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\DefaultsMode\Exception\ConfigurationException
  • 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\DocDBElastic\Exception\DocDBElasticException
  • Aws\drs\Exception\drsException
  • 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\EMRServerless\Exception\EMRServerlessException
  • Aws\Endpoint\UseDualstackEndpoint\Exception\ConfigurationException
  • Aws\Endpoint\UseFipsEndpoint\Exception\ConfigurationException
  • Aws\EndpointDiscovery\Exception\ConfigurationException
  • Aws\EventBridge\Exception\EventBridgeException
  • Aws\Exception\AwsException
  • Aws\Exception\CommonRuntimeException
  • 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\TokenException
  • Aws\Exception\UnresolvedApiException
  • Aws\Exception\UnresolvedEndpointException
  • Aws\Exception\UnresolvedSignatureException
  • Aws\finspace\Exception\finspaceException
  • Aws\FinSpaceData\Exception\FinSpaceDataException
  • Aws\Firehose\Exception\FirehoseException
  • Aws\FIS\Exception\FISException
  • 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\GameSparks\Exception\GameSparksException
  • 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\Inspector2\Exception\Inspector2Exception
  • Aws\Inspector\Exception\InspectorException
  • Aws\InternetMonitor\Exception\InternetMonitorException
  • 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\IoTFleetWise\Exception\IoTFleetWiseException
  • Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException
  • Aws\IoTRoboRunner\Exception\IoTRoboRunnerException
  • Aws\IoTSecureTunneling\Exception\IoTSecureTunnelingException
  • Aws\IoTSiteWise\Exception\IoTSiteWiseException
  • Aws\IoTThingsGraph\Exception\IoTThingsGraphException
  • Aws\IoTTwinMaker\Exception\IoTTwinMakerException
  • Aws\IoTWireless\Exception\IoTWirelessException
  • Aws\IVS\Exception\IVSException
  • Aws\ivschat\Exception\ivschatException
  • Aws\IVSRealTime\Exception\IVSRealTimeException
  • Aws\Kafka\Exception\KafkaException
  • Aws\KafkaConnect\Exception\KafkaConnectException
  • Aws\kendra\Exception\kendraException
  • Aws\KendraRanking\Exception\KendraRankingException
  • Aws\Keyspaces\Exception\KeyspacesException
  • 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\KinesisVideoWebRTCStorage\Exception\KinesisVideoWebRTCStorageException
  • 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\LicenseManagerLinuxSubscriptions\Exception\LicenseManagerLinuxSubscriptionsException
  • Aws\LicenseManagerUserSubscriptions\Exception\LicenseManagerUserSubscriptionsException
  • Aws\Lightsail\Exception\LightsailException
  • Aws\LocationService\Exception\LocationServiceException
  • Aws\LookoutEquipment\Exception\LookoutEquipmentException
  • Aws\LookoutforVision\Exception\LookoutforVisionException
  • Aws\LookoutMetrics\Exception\LookoutMetricsException
  • Aws\MachineLearning\Exception\MachineLearningException
  • Aws\Macie2\Exception\Macie2Exception
  • Aws\Macie\Exception\MacieException
  • Aws\MainframeModernization\Exception\MainframeModernizationException
  • Aws\ManagedBlockchain\Exception\ManagedBlockchainException
  • Aws\ManagedGrafana\Exception\ManagedGrafanaException
  • 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\MemoryDB\Exception\MemoryDBException
  • Aws\mgn\Exception\mgnException
  • Aws\MigrationHub\Exception\MigrationHubException
  • Aws\MigrationHubConfig\Exception\MigrationHubConfigException
  • Aws\MigrationHubOrchestrator\Exception\MigrationHubOrchestratorException
  • Aws\MigrationHubRefactorSpaces\Exception\MigrationHubRefactorSpacesException
  • Aws\MigrationHubStrategyRecommendations\Exception\MigrationHubStrategyRecommendationsException
  • 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\NimbleStudio\Exception\NimbleStudioException
  • Aws\OAM\Exception\OAMException
  • Aws\Omics\Exception\OmicsException
  • Aws\OpenSearchServerless\Exception\OpenSearchServerlessException
  • Aws\OpenSearchService\Exception\OpenSearchServiceException
  • Aws\OpsWorks\Exception\OpsWorksException
  • Aws\OpsWorksCM\Exception\OpsWorksCMException
  • Aws\Organizations\Exception\OrganizationsException
  • Aws\Outposts\Exception\OutpostsException
  • Aws\Panorama\Exception\PanoramaException
  • 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\PinpointSMSVoiceV2\Exception\PinpointSMSVoiceV2Exception
  • Aws\Pipes\Exception\PipesException
  • Aws\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • Aws\PrivateNetworks\Exception\PrivateNetworksException
  • Aws\PrometheusService\Exception\PrometheusServiceException
  • Aws\Proton\Exception\ProtonException
  • 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\RecycleBin\Exception\RecycleBinException
  • Aws\Redshift\Exception\RedshiftException
  • Aws\RedshiftDataAPIService\Exception\RedshiftDataAPIServiceException
  • Aws\RedshiftServerless\Exception\RedshiftServerlessException
  • Aws\Rekognition\Exception\RekognitionException
  • Aws\ResilienceHub\Exception\ResilienceHubException
  • Aws\ResourceExplorer2\Exception\ResourceExplorer2Exception
  • Aws\ResourceGroups\Exception\ResourceGroupsException
  • Aws\ResourceGroupsTaggingAPI\Exception\ResourceGroupsTaggingAPIException
  • Aws\Retry\Exception\ConfigurationException
  • Aws\RoboMaker\Exception\RoboMakerException
  • Aws\RolesAnywhere\Exception\RolesAnywhereException
  • Aws\Route53\Exception\Route53Exception
  • Aws\Route53Domains\Exception\Route53DomainsException
  • Aws\Route53RecoveryCluster\Exception\Route53RecoveryClusterException
  • Aws\Route53RecoveryControlConfig\Exception\Route53RecoveryControlConfigException
  • Aws\Route53RecoveryReadiness\Exception\Route53RecoveryReadinessException
  • 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\SageMakerGeospatial\Exception\SageMakerGeospatialException
  • Aws\SageMakerMetrics\Exception\SageMakerMetricsException
  • Aws\SageMakerRuntime\Exception\SageMakerRuntimeException
  • Aws\SavingsPlans\Exception\SavingsPlansException
  • Aws\Scheduler\Exception\SchedulerException
  • Aws\Schemas\Exception\SchemasException
  • Aws\SecretsManager\Exception\SecretsManagerException
  • Aws\SecurityHub\Exception\SecurityHubException
  • Aws\SecurityLake\Exception\SecurityLakeException
  • 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\SimSpaceWeaver\Exception\SimSpaceWeaverException
  • Aws\Sms\Exception\SmsException
  • Aws\SnowBall\Exception\SnowBallException
  • Aws\SnowDeviceManagement\Exception\SnowDeviceManagementException
  • Aws\Sns\Exception\InvalidSnsMessageException
  • Aws\Sns\Exception\SnsException
  • Aws\Sqs\Exception\SqsException
  • Aws\Ssm\Exception\SsmException
  • Aws\SSMContacts\Exception\SSMContactsException
  • Aws\SSMIncidents\Exception\SSMIncidentsException
  • Aws\SsmSap\Exception\SsmSapException
  • 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\SupportApp\Exception\SupportAppException
  • Aws\Swf\Exception\SwfException
  • Aws\Synthetics\Exception\SyntheticsException
  • Aws\Textract\Exception\TextractException
  • Aws\TimestreamQuery\Exception\TimestreamQueryException
  • Aws\TimestreamWrite\Exception\TimestreamWriteException
  • Aws\Tnb\Exception\TnbException
  • Aws\TranscribeService\Exception\TranscribeServiceException
  • Aws\Transfer\Exception\TransferException
  • Aws\Translate\Exception\TranslateException
  • Aws\VoiceID\Exception\VoiceIDException
  • 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\WorkSpacesWeb\Exception\WorkSpacesWebException
  • 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_fips_pseudo_region
  • 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
  • Aws\strip_fips_pseudo_regions

AWS Backup Gateway 2021-01-01

Client: Aws\BackupGateway\BackupGatewayClient
Service ID: backup-gateway
Version: 2021-01-01

This page describes the parameters and results for the operations of the AWS Backup Gateway (2021-01-01), and shows how to use the Aws\BackupGateway\BackupGatewayClient object to call the described operations. This documentation is specific to the 2021-01-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 */).

  • AssociateGatewayToServer ( array $params = [] )

    Associates a backup gateway with your server.

  • CreateGateway ( array $params = [] )

    Creates a backup gateway.

  • DeleteGateway ( array $params = [] )

    Deletes a backup gateway.

  • DeleteHypervisor ( array $params = [] )

    Deletes a hypervisor.

  • DisassociateGatewayFromServer ( array $params = [] )

    Disassociates a backup gateway from the specified server.

  • GetBandwidthRateLimitSchedule ( array $params = [] )

    Retrieves the bandwidth rate limit schedule for a specified gateway.

  • GetGateway ( array $params = [] )

    By providing the ARN (Amazon Resource Name), this API returns the gateway.

  • GetHypervisor ( array $params = [] )

    This action requests information about the specified hypervisor to which the gateway will connect.

  • GetHypervisorPropertyMappings ( array $params = [] )

    This action retrieves the property mappings for the specified hypervisor.

  • GetVirtualMachine ( array $params = [] )

    By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

  • ImportHypervisorConfiguration ( array $params = [] )

    Connect to a hypervisor by importing its configuration.

  • ListGateways ( array $params = [] )

    Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.

  • ListHypervisors ( array $params = [] )

    Lists your hypervisors.

  • ListTagsForResource ( array $params = [] )

    Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

  • ListVirtualMachines ( array $params = [] )

    Lists your virtual machines.

  • PutBandwidthRateLimitSchedule ( array $params = [] )

    This action sets the bandwidth rate limit schedule for a specified gateway.

  • PutHypervisorPropertyMappings ( array $params = [] )

    This action sets the property mappings for the specified hypervisor.

  • PutMaintenanceStartTime ( array $params = [] )

    Set the maintenance start time for a gateway.

  • StartVirtualMachinesMetadataSync ( array $params = [] )

    This action sends a request to sync metadata across the specified virtual machines.

  • TagResource ( array $params = [] )

    Tag the resource.

  • TestHypervisorConfiguration ( array $params = [] )

    Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

  • UntagResource ( array $params = [] )

    Removes tags from the resource.

  • UpdateGatewayInformation ( array $params = [] )

    Updates a gateway's name.

  • UpdateGatewaySoftwareNow ( array $params = [] )

    Updates the gateway virtual machine (VM) software.

  • UpdateHypervisor ( array $params = [] )

    Updates a hypervisor metadata, including its host, username, and password.

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:

  • ListGateways
  • ListHypervisors
  • ListVirtualMachines

Operations

AssociateGatewayToServer

$result = $client->associateGatewayToServer([/* ... */]);
$promise = $client->associateGatewayToServerAsync([/* ... */]);

Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.

Parameter Syntax

$result = $client->associateGatewayToServer([
    'GatewayArn' => '<string>', // REQUIRED
    'ServerArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
GatewayArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

ServerArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the server that hosts your virtual machines.

Result Syntax

[
    'GatewayArn' => '<string>',
]

Result Details

Members
GatewayArn
  • Type: string

The Amazon Resource Name (ARN) of a gateway.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • ConflictException:

    The operation cannot proceed because it is not supported.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

CreateGateway

$result = $client->createGateway([/* ... */]);
$promise = $client->createGatewayAsync([/* ... */]);

Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.

Parameter Syntax

$result = $client->createGateway([
    'ActivationKey' => '<string>', // REQUIRED
    'GatewayDisplayName' => '<string>', // REQUIRED
    'GatewayType' => 'BACKUP_VM', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ActivationKey
  • Required: Yes
  • Type: string

The activation key of the created gateway.

GatewayDisplayName
  • Required: Yes
  • Type: string

The display name of the created gateway.

GatewayType
  • Required: Yes
  • Type: string

The type of created gateway.

Tags
  • Type: Array of Tag structures

A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.

Result Syntax

[
    'GatewayArn' => '<string>',
]

Result Details

Members
GatewayArn
  • Type: string

The Amazon Resource Name (ARN) of the gateway you create.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

DeleteGateway

$result = $client->deleteGateway([/* ... */]);
$promise = $client->deleteGatewayAsync([/* ... */]);

Deletes a backup gateway.

Parameter Syntax

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

Parameter Details

Members
GatewayArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the gateway to delete.

Result Syntax

[
    'GatewayArn' => '<string>',
]

Result Details

Members
GatewayArn
  • Type: string

The Amazon Resource Name (ARN) of the gateway you deleted.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

DeleteHypervisor

$result = $client->deleteHypervisor([/* ... */]);
$promise = $client->deleteHypervisorAsync([/* ... */]);

Deletes a hypervisor.

Parameter Syntax

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

Parameter Details

Members
HypervisorArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the hypervisor to delete.

Result Syntax

[
    'HypervisorArn' => '<string>',
]

Result Details

Members
HypervisorArn
  • Type: string

The Amazon Resource Name (ARN) of the hypervisor you deleted.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • ConflictException:

    The operation cannot proceed because it is not supported.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • AccessDeniedException:

    The operation cannot proceed because you have insufficient permissions.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

DisassociateGatewayFromServer

$result = $client->disassociateGatewayFromServer([/* ... */]);
$promise = $client->disassociateGatewayFromServerAsync([/* ... */]);

Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.

Parameter Syntax

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

Parameter Details

Members
GatewayArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the gateway to disassociate.

Result Syntax

[
    'GatewayArn' => '<string>',
]

Result Details

Members
GatewayArn
  • Type: string

The Amazon Resource Name (ARN) of the gateway you disassociated.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • ConflictException:

    The operation cannot proceed because it is not supported.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

GetBandwidthRateLimitSchedule

$result = $client->getBandwidthRateLimitSchedule([/* ... */]);
$promise = $client->getBandwidthRateLimitScheduleAsync([/* ... */]);

Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.

Parameter Syntax

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

Parameter Details

Members
GatewayArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Result Syntax

[
    'BandwidthRateLimitIntervals' => [
        [
            'AverageUploadRateLimitInBitsPerSec' => <integer>,
            'DaysOfWeek' => [<integer>, ...],
            'EndHourOfDay' => <integer>,
            'EndMinuteOfHour' => <integer>,
            'StartHourOfDay' => <integer>,
            'StartMinuteOfHour' => <integer>,
        ],
        // ...
    ],
    'GatewayArn' => '<string>',
]

Result Details

Members
BandwidthRateLimitIntervals
  • Type: Array of BandwidthRateLimitInterval structures

An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.

GatewayArn
  • Type: string

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

GetGateway

$result = $client->getGateway([/* ... */]);
$promise = $client->getGatewayAsync([/* ... */]);

By providing the ARN (Amazon Resource Name), this API returns the gateway.

Parameter Syntax

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

Parameter Details

Members
GatewayArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the gateway.

Result Syntax

[
    'Gateway' => [
        'GatewayArn' => '<string>',
        'GatewayDisplayName' => '<string>',
        'GatewayType' => 'BACKUP_VM',
        'HypervisorId' => '<string>',
        'LastSeenTime' => <DateTime>,
        'MaintenanceStartTime' => [
            'DayOfMonth' => <integer>,
            'DayOfWeek' => <integer>,
            'HourOfDay' => <integer>,
            'MinuteOfHour' => <integer>,
        ],
        'NextUpdateAvailabilityTime' => <DateTime>,
        'VpcEndpoint' => '<string>',
    ],
]

Result Details

Members
Gateway
  • Type: GatewayDetails structure

By providing the ARN (Amazon Resource Name), this API returns the gateway.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

GetHypervisor

$result = $client->getHypervisor([/* ... */]);
$promise = $client->getHypervisorAsync([/* ... */]);

This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

Parameter Syntax

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

Parameter Details

Members
HypervisorArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the hypervisor.

Result Syntax

[
    'Hypervisor' => [
        'Host' => '<string>',
        'HypervisorArn' => '<string>',
        'KmsKeyArn' => '<string>',
        'LastSuccessfulMetadataSyncTime' => <DateTime>,
        'LatestMetadataSyncStatus' => 'CREATED|RUNNING|FAILED|PARTIALLY_FAILED|SUCCEEDED',
        'LatestMetadataSyncStatusMessage' => '<string>',
        'LogGroupArn' => '<string>',
        'Name' => '<string>',
        'State' => 'PENDING|ONLINE|OFFLINE|ERROR',
    ],
]

Result Details

Members
Hypervisor
  • Type: HypervisorDetails structure

Details about the requested hypervisor.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

GetHypervisorPropertyMappings

$result = $client->getHypervisorPropertyMappings([/* ... */]);
$promise = $client->getHypervisorPropertyMappingsAsync([/* ... */]);

This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.

Parameter Syntax

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

Parameter Details

Members
HypervisorArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the hypervisor.

Result Syntax

[
    'HypervisorArn' => '<string>',
    'IamRoleArn' => '<string>',
    'VmwareToAwsTagMappings' => [
        [
            'AwsTagKey' => '<string>',
            'AwsTagValue' => '<string>',
            'VmwareCategory' => '<string>',
            'VmwareTagName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
HypervisorArn
  • Type: string

The Amazon Resource Name (ARN) of the hypervisor.

IamRoleArn
  • Type: string

The Amazon Resource Name (ARN) of the IAM role.

VmwareToAwsTagMappings
  • Type: Array of VmwareToAwsTagMapping structures

This is a display of the mappings of on-premises VMware tags to the Amazon Web Services tags.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

GetVirtualMachine

$result = $client->getVirtualMachine([/* ... */]);
$promise = $client->getVirtualMachineAsync([/* ... */]);

By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the virtual machine.

Result Syntax

[
    'VirtualMachine' => [
        'HostName' => '<string>',
        'HypervisorId' => '<string>',
        'LastBackupDate' => <DateTime>,
        'Name' => '<string>',
        'Path' => '<string>',
        'ResourceArn' => '<string>',
        'VmwareTags' => [
            [
                'VmwareCategory' => '<string>',
                'VmwareTagDescription' => '<string>',
                'VmwareTagName' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
VirtualMachine
  • Type: VirtualMachineDetails structure

This object contains the basic attributes of VirtualMachine contained by the output of GetVirtualMachine

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

ImportHypervisorConfiguration

$result = $client->importHypervisorConfiguration([/* ... */]);
$promise = $client->importHypervisorConfigurationAsync([/* ... */]);

Connect to a hypervisor by importing its configuration.

Parameter Syntax

$result = $client->importHypervisorConfiguration([
    'Host' => '<string>', // REQUIRED
    'KmsKeyArn' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Password' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Username' => '<string>',
]);

Parameter Details

Members
Host
  • Required: Yes
  • Type: string

The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

KmsKeyArn
  • Type: string

The Key Management Service for the hypervisor.

Name
  • Required: Yes
  • Type: string

The name of the hypervisor.

Password
  • Type: string

The password for the hypervisor.

Tags
  • Type: Array of Tag structures

The tags of the hypervisor configuration to import.

Username
  • Type: string

The username for the hypervisor.

Result Syntax

[
    'HypervisorArn' => '<string>',
]

Result Details

Members
HypervisorArn
  • Type: string

The Amazon Resource Name (ARN) of the hypervisor you disassociated.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • ConflictException:

    The operation cannot proceed because it is not supported.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • AccessDeniedException:

    The operation cannot proceed because you have insufficient permissions.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

ListGateways

$result = $client->listGateways([/* ... */]);
$promise = $client->listGatewaysAsync([/* ... */]);

Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of gateways to list.

NextToken
  • Type: string

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Result Syntax

[
    'Gateways' => [
        [
            'GatewayArn' => '<string>',
            'GatewayDisplayName' => '<string>',
            'GatewayType' => 'BACKUP_VM',
            'HypervisorId' => '<string>',
            'LastSeenTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Gateways
  • Type: Array of Gateway structures

A list of your gateways.

NextToken
  • Type: string

The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

ListHypervisors

$result = $client->listHypervisors([/* ... */]);
$promise = $client->listHypervisorsAsync([/* ... */]);

Lists your hypervisors.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of hypervisors to list.

NextToken
  • Type: string

The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Result Syntax

[
    'Hypervisors' => [
        [
            'Host' => '<string>',
            'HypervisorArn' => '<string>',
            'KmsKeyArn' => '<string>',
            'Name' => '<string>',
            'State' => 'PENDING|ONLINE|OFFLINE|ERROR',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Hypervisors
  • Type: Array of Hypervisor structures

A list of your Hypervisor objects, ordered by their Amazon Resource Names (ARNs).

NextToken
  • Type: string

The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

ListTagsForResource

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

Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource's tags to list.

Result Syntax

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

Result Details

Members
ResourceArn
  • Type: string

The Amazon Resource Name (ARN) of the resource's tags that you listed.

Tags
  • Type: Array of Tag structures

A list of the resource's tags.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

ListVirtualMachines

$result = $client->listVirtualMachines([/* ... */]);
$promise = $client->listVirtualMachinesAsync([/* ... */]);

Lists your virtual machines.

Parameter Syntax

$result = $client->listVirtualMachines([
    'HypervisorArn' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
HypervisorArn
  • Type: string

The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.

MaxResults
  • Type: int

The maximum number of virtual machines to list.

NextToken
  • Type: string

The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Result Syntax

[
    'NextToken' => '<string>',
    'VirtualMachines' => [
        [
            'HostName' => '<string>',
            'HypervisorId' => '<string>',
            'LastBackupDate' => <DateTime>,
            'Name' => '<string>',
            'Path' => '<string>',
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

VirtualMachines
  • Type: Array of VirtualMachine structures

A list of your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

PutBandwidthRateLimitSchedule

$result = $client->putBandwidthRateLimitSchedule([/* ... */]);
$promise = $client->putBandwidthRateLimitScheduleAsync([/* ... */]);

This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.

Parameter Syntax

$result = $client->putBandwidthRateLimitSchedule([
    'BandwidthRateLimitIntervals' => [ // REQUIRED
        [
            'AverageUploadRateLimitInBitsPerSec' => <integer>,
            'DaysOfWeek' => [<integer>, ...], // REQUIRED
            'EndHourOfDay' => <integer>, // REQUIRED
            'EndMinuteOfHour' => <integer>, // REQUIRED
            'StartHourOfDay' => <integer>, // REQUIRED
            'StartMinuteOfHour' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'GatewayArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
BandwidthRateLimitIntervals
  • Required: Yes
  • Type: Array of BandwidthRateLimitInterval structures

An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.

GatewayArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Result Syntax

[
    'GatewayArn' => '<string>',
]

Result Details

Members
GatewayArn
  • Type: string

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

PutHypervisorPropertyMappings

$result = $client->putHypervisorPropertyMappings([/* ... */]);
$promise = $client->putHypervisorPropertyMappingsAsync([/* ... */]);

This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.

Parameter Syntax

$result = $client->putHypervisorPropertyMappings([
    'HypervisorArn' => '<string>', // REQUIRED
    'IamRoleArn' => '<string>', // REQUIRED
    'VmwareToAwsTagMappings' => [ // REQUIRED
        [
            'AwsTagKey' => '<string>', // REQUIRED
            'AwsTagValue' => '<string>', // REQUIRED
            'VmwareCategory' => '<string>', // REQUIRED
            'VmwareTagName' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
HypervisorArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the hypervisor.

IamRoleArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the IAM role.

VmwareToAwsTagMappings
  • Required: Yes
  • Type: Array of VmwareToAwsTagMapping structures

This action requests the mappings of on-premises VMware tags to the Amazon Web Services tags.

Result Syntax

[
    'HypervisorArn' => '<string>',
]

Result Details

Members
HypervisorArn
  • Type: string

The Amazon Resource Name (ARN) of the hypervisor.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • ConflictException:

    The operation cannot proceed because it is not supported.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • AccessDeniedException:

    The operation cannot proceed because you have insufficient permissions.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

PutMaintenanceStartTime

$result = $client->putMaintenanceStartTime([/* ... */]);
$promise = $client->putMaintenanceStartTimeAsync([/* ... */]);

Set the maintenance start time for a gateway.

Parameter Syntax

$result = $client->putMaintenanceStartTime([
    'DayOfMonth' => <integer>,
    'DayOfWeek' => <integer>,
    'GatewayArn' => '<string>', // REQUIRED
    'HourOfDay' => <integer>, // REQUIRED
    'MinuteOfHour' => <integer>, // REQUIRED
]);

Parameter Details

Members
DayOfMonth
  • Type: int

The day of the month start maintenance on a gateway.

Valid values range from Sunday to Saturday.

DayOfWeek
  • Type: int

The day of the week to start maintenance on a gateway.

GatewayArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.

HourOfDay
  • Required: Yes
  • Type: int

The hour of the day to start maintenance on a gateway.

MinuteOfHour
  • Required: Yes
  • Type: int

The minute of the hour to start maintenance on a gateway.

Result Syntax

[
    'GatewayArn' => '<string>',
]

Result Details

Members
GatewayArn
  • Type: string

The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start time.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • ConflictException:

    The operation cannot proceed because it is not supported.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

StartVirtualMachinesMetadataSync

$result = $client->startVirtualMachinesMetadataSync([/* ... */]);
$promise = $client->startVirtualMachinesMetadataSyncAsync([/* ... */]);

This action sends a request to sync metadata across the specified virtual machines.

Parameter Syntax

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

Parameter Details

Members
HypervisorArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the hypervisor.

Result Syntax

[
    'HypervisorArn' => '<string>',
]

Result Details

Members
HypervisorArn
  • Type: string

The Amazon Resource Name (ARN) of the hypervisor.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • AccessDeniedException:

    The operation cannot proceed because you have insufficient permissions.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

TagResource

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

Tag the 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 resource to tag.

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

A list of tags to assign to the resource.

Result Syntax

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

Result Details

Members
ResourceARN
  • Type: string

The Amazon Resource Name (ARN) of the resource you tagged.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

TestHypervisorConfiguration

$result = $client->testHypervisorConfiguration([/* ... */]);
$promise = $client->testHypervisorConfigurationAsync([/* ... */]);

Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

Parameter Syntax

$result = $client->testHypervisorConfiguration([
    'GatewayArn' => '<string>', // REQUIRED
    'Host' => '<string>', // REQUIRED
    'Password' => '<string>',
    'Username' => '<string>',
]);

Parameter Details

Members
GatewayArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.

Host
  • Required: Yes
  • Type: string

The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

Password
  • Type: string

The password for the hypervisor.

Username
  • Type: string

The username for the hypervisor.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • ConflictException:

    The operation cannot proceed because it is not supported.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

UntagResource

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

Removes tags from the resource.

Parameter Syntax

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

Parameter Details

Members
ResourceARN
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource from which to remove tags.

TagKeys
  • Required: Yes
  • Type: Array of strings

The list of tag keys specifying which tags to remove.

Result Syntax

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

Result Details

Members
ResourceARN
  • Type: string

The Amazon Resource Name (ARN) of the resource from which you removed tags.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

UpdateGatewayInformation

$result = $client->updateGatewayInformation([/* ... */]);
$promise = $client->updateGatewayInformationAsync([/* ... */]);

Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

Parameter Syntax

$result = $client->updateGatewayInformation([
    'GatewayArn' => '<string>', // REQUIRED
    'GatewayDisplayName' => '<string>',
]);

Parameter Details

Members
GatewayArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the gateway to update.

GatewayDisplayName
  • Type: string

The updated display name of the gateway.

Result Syntax

[
    'GatewayArn' => '<string>',
]

Result Details

Members
GatewayArn
  • Type: string

The Amazon Resource Name (ARN) of the gateway you updated.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • ConflictException:

    The operation cannot proceed because it is not supported.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

UpdateGatewaySoftwareNow

$result = $client->updateGatewaySoftwareNow([/* ... */]);
$promise = $client->updateGatewaySoftwareNowAsync([/* ... */]);

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete.

Parameter Syntax

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

Parameter Details

Members
GatewayArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the gateway to be updated.

Result Syntax

[
    'GatewayArn' => '<string>',
]

Result Details

Members
GatewayArn
  • Type: string

The Amazon Resource Name (ARN) of the gateway you updated.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

UpdateHypervisor

$result = $client->updateHypervisor([/* ... */]);
$promise = $client->updateHypervisorAsync([/* ... */]);

Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.

Parameter Syntax

$result = $client->updateHypervisor([
    'Host' => '<string>',
    'HypervisorArn' => '<string>', // REQUIRED
    'LogGroupArn' => '<string>',
    'Name' => '<string>',
    'Password' => '<string>',
    'Username' => '<string>',
]);

Parameter Details

Members
Host
  • Type: string

The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

HypervisorArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the hypervisor to update.

LogGroupArn
  • Type: string

The Amazon Resource Name (ARN) of the group of gateways within the requested log.

Name
  • Type: string

The updated name for the hypervisor

Password
  • Type: string

The updated password for the hypervisor.

Username
  • Type: string

The updated username for the hypervisor.

Result Syntax

[
    'HypervisorArn' => '<string>',
]

Result Details

Members
HypervisorArn
  • Type: string

The Amazon Resource Name (ARN) of the hypervisor you updated.

Errors

  • ValidationException:

    The operation did not succeed because a validation error occurred.

  • ConflictException:

    The operation cannot proceed because it is not supported.

  • InternalServerException:

    The operation did not succeed because an internal error occurred. Try again later.

  • AccessDeniedException:

    The operation cannot proceed because you have insufficient permissions.

  • ResourceNotFoundException:

    A resource that is required for the action wasn't found.

  • ThrottlingException:

    TPS has been limited to protect against intentional or unintentional high request volumes.

Shapes

AccessDeniedException

Description

The operation cannot proceed because you have insufficient permissions.

Members
ErrorCode
  • Required: Yes
  • Type: string

A description of why you have insufficient permissions.

Message
  • Type: string

BandwidthRateLimitInterval

Description

Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.

Members
AverageUploadRateLimitInBitsPerSec
  • Type: long (int|float)

The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.

For Backup Gateway, the minimum value is (Value).

DaysOfWeek
  • Required: Yes
  • Type: Array of ints

The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.

EndHourOfDay
  • Required: Yes
  • Type: int

The hour of the day to end the bandwidth rate limit interval.

EndMinuteOfHour
  • Required: Yes
  • Type: int

The minute of the hour to end the bandwidth rate limit interval.

The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value 59.

StartHourOfDay
  • Required: Yes
  • Type: int

The hour of the day to start the bandwidth rate limit interval.

StartMinuteOfHour
  • Required: Yes
  • Type: int

The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value 0.

ConflictException

Description

The operation cannot proceed because it is not supported.

Members
ErrorCode
  • Required: Yes
  • Type: string

A description of why the operation is not supported.

Message
  • Type: string

Gateway

Description

A gateway is an Backup Gateway appliance that runs on the customer's network to provide seamless connectivity to backup storage in the Amazon Web Services Cloud.

Members
GatewayArn
  • Type: string

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

GatewayDisplayName
  • Type: string

The display name of the gateway.

GatewayType
  • Type: string

The type of the gateway.

HypervisorId
  • Type: string

The hypervisor ID of the gateway.

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

The last time Backup gateway communicated with the gateway, in Unix format and UTC time.

GatewayDetails

Description

The details of gateway.

Members
GatewayArn
  • Type: string

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

GatewayDisplayName
  • Type: string

The display name of the gateway.

GatewayType
  • Type: string

The type of the gateway type.

HypervisorId
  • Type: string

The hypervisor ID of the gateway.

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

Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.

MaintenanceStartTime
  • Type: MaintenanceStartTime structure

Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.

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

Details showing the next update availability time of the gateway.

VpcEndpoint
  • Type: string

The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway.

Hypervisor

Description

Represents the hypervisor's permissions to which the gateway will connect.

A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

Members
Host
  • Type: string

The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

HypervisorArn
  • Type: string

The Amazon Resource Name (ARN) of the hypervisor.

KmsKeyArn
  • Type: string

The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the hypervisor.

Name
  • Type: string

The name of the hypervisor.

State
  • Type: string

The state of the hypervisor.

HypervisorDetails

Description

These are the details of the specified hypervisor. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

Members
Host
  • Type: string

The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

HypervisorArn
  • Type: string

The Amazon Resource Name (ARN) of the hypervisor.

KmsKeyArn
  • Type: string

The Amazon Resource Name (ARN) of the KMS used to encrypt the hypervisor.

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

This is the time when the most recent successful sync of metadata occurred.

LatestMetadataSyncStatus
  • Type: string

This is the most recent status for the indicated metadata sync.

LatestMetadataSyncStatusMessage
  • Type: string

This is the most recent status for the indicated metadata sync.

LogGroupArn
  • Type: string

The Amazon Resource Name (ARN) of the group of gateways within the requested log.

Name
  • Type: string

This is the name of the specified hypervisor.

State
  • Type: string

This is the current state of the specified hypervisor.

The possible states are PENDING, ONLINE, OFFLINE, or ERROR.

InternalServerException

Description

The operation did not succeed because an internal error occurred. Try again later.

Members
ErrorCode
  • Type: string

A description of which internal error occured.

Message
  • Type: string

MaintenanceStartTime

Description

This is your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.

Members
DayOfMonth
  • Type: int

The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.

DayOfWeek
  • Type: int

An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.

HourOfDay
  • Required: Yes
  • Type: int

The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

MinuteOfHour
  • Required: Yes
  • Type: int

The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.

ResourceNotFoundException

Description

A resource that is required for the action wasn't found.

Members
ErrorCode
  • Type: string

A description of which resource wasn't found.

Message
  • Type: string

Tag

Description

A key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

Members
Key
  • Required: Yes
  • Type: string

The key part of a tag's key-value pair. The key can't start with aws:.

Value
  • Required: Yes
  • Type: string

The value part of a tag's key-value pair.

ThrottlingException

Description

TPS has been limited to protect against intentional or unintentional high request volumes.

Members
ErrorCode
  • Required: Yes
  • Type: string

Error: TPS has been limited to protect against intentional or unintentional high request volumes.

Message
  • Type: string

ValidationException

Description

The operation did not succeed because a validation error occurred.

Members
ErrorCode
  • Type: string

A description of what caused the validation error.

Message
  • Type: string

VirtualMachine

Description

A virtual machine that is on a hypervisor.

Members
HostName
  • Type: string

The host name of the virtual machine.

HypervisorId
  • Type: string

The ID of the virtual machine's hypervisor.

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

The most recent date a virtual machine was backed up, in Unix format and UTC time.

Name
  • Type: string

The name of the virtual machine.

Path
  • Type: string

The path of the virtual machine.

ResourceArn
  • Type: string

The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL.

VirtualMachineDetails

Description

Your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).

Members
HostName
  • Type: string

The host name of the virtual machine.

HypervisorId
  • Type: string

The ID of the virtual machine's hypervisor.

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

The most recent date a virtual machine was backed up, in Unix format and UTC time.

Name
  • Type: string

The name of the virtual machine.

Path
  • Type: string

The path of the virtual machine.

ResourceArn
  • Type: string

The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL.

VmwareTags
  • Type: Array of VmwareTag structures

These are the details of the VMware tags associated with the specified virtual machine.

VmwareTag

Description

A VMware tag is a tag attached to a specific virtual machine. A tag is a key-value pair you can use to manage, filter, and search for your resources.

The content of VMware tags can be matched to Amazon Web Services tags.

Members
VmwareCategory
  • Type: string

The is the category of VMware.

VmwareTagDescription
  • Type: string

This is a user-defined description of a VMware tag.

VmwareTagName
  • Type: string

This is the user-defined name of a VMware tag.

VmwareToAwsTagMapping

Description

This displays the mapping of on-premises VMware tags to the corresponding Amazon Web Services tags.

Members
AwsTagKey
  • Required: Yes
  • Type: string

The key part of the Amazon Web Services tag's key-value pair.

AwsTagValue
  • Required: Yes
  • Type: string

The value part of the Amazon Web Services tag's key-value pair.

VmwareCategory
  • Required: Yes
  • Type: string

The is the category of VMware.

VmwareTagName
  • Required: Yes
  • Type: string

This is the user-defined name of a VMware tag.

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