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
    • VPCLattice
      • 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\VPCLattice\VPCLatticeClient
  • 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\VPCLattice\Exception\VPCLatticeException
  • 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 Server Migration Service 2016-10-24

Client: Aws\Sms\SmsClient
Service ID: sms
Version: 2016-10-24

This page describes the parameters and results for the operations of the AWS Server Migration Service (2016-10-24), and shows how to use the Aws\Sms\SmsClient object to call the described operations. This documentation is specific to the 2016-10-24 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 */).

  • CreateApp ( array $params = [] )

    Creates an application.

  • CreateReplicationJob ( array $params = [] )

    Creates a replication job.

  • DeleteApp ( array $params = [] )

    Deletes the specified application.

  • DeleteAppLaunchConfiguration ( array $params = [] )

    Deletes the launch configuration for the specified application.

  • DeleteAppReplicationConfiguration ( array $params = [] )

    Deletes the replication configuration for the specified application.

  • DeleteAppValidationConfiguration ( array $params = [] )

    Deletes the validation configuration for the specified application.

  • DeleteReplicationJob ( array $params = [] )

    Deletes the specified replication job.

  • DeleteServerCatalog ( array $params = [] )

    Deletes all servers from your server catalog.

  • DisassociateConnector ( array $params = [] )

    Disassociates the specified connector from Server Migration Service.

  • GenerateChangeSet ( array $params = [] )

    Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

  • GenerateTemplate ( array $params = [] )

    Generates an CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

  • GetApp ( array $params = [] )

    Retrieve information about the specified application.

  • GetAppLaunchConfiguration ( array $params = [] )

    Retrieves the application launch configuration associated with the specified application.

  • GetAppReplicationConfiguration ( array $params = [] )

    Retrieves the application replication configuration associated with the specified application.

  • GetAppValidationConfiguration ( array $params = [] )

    Retrieves information about a configuration for validating an application.

  • GetAppValidationOutput ( array $params = [] )

    Retrieves output from validating an application.

  • GetConnectors ( array $params = [] )

    Describes the connectors registered with the Server Migration Service.

  • GetReplicationJobs ( array $params = [] )

    Describes the specified replication job or all of your replication jobs.

  • GetReplicationRuns ( array $params = [] )

    Describes the replication runs for the specified replication job.

  • GetServers ( array $params = [] )

    Describes the servers in your server catalog.

  • ImportAppCatalog ( array $params = [] )

    Allows application import from Migration Hub.

  • ImportServerCatalog ( array $params = [] )

    Gathers a complete list of on-premises servers.

  • LaunchApp ( array $params = [] )

    Launches the specified application as a stack in CloudFormation.

  • ListApps ( array $params = [] )

    Retrieves summaries for all applications.

  • NotifyAppValidationOutput ( array $params = [] )

    Provides information to Server Migration Service about whether application validation is successful.

  • PutAppLaunchConfiguration ( array $params = [] )

    Creates or updates the launch configuration for the specified application.

  • PutAppReplicationConfiguration ( array $params = [] )

    Creates or updates the replication configuration for the specified application.

  • PutAppValidationConfiguration ( array $params = [] )

    Creates or updates a validation configuration for the specified application.

  • StartAppReplication ( array $params = [] )

    Starts replicating the specified application by creating replication jobs for each server in the application.

  • StartOnDemandAppReplication ( array $params = [] )

    Starts an on-demand replication run for the specified application.

  • StartOnDemandReplicationRun ( array $params = [] )

    Starts an on-demand replication run for the specified replication job.

  • StopAppReplication ( array $params = [] )

    Stops replicating the specified application by deleting the replication job for each server in the application.

  • TerminateApp ( array $params = [] )

    Terminates the stack for the specified application.

  • UpdateApp ( array $params = [] )

    Updates the specified application.

  • UpdateReplicationJob ( array $params = [] )

    Updates the specified settings for the specified replication job.

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:

  • GetConnectors
  • GetReplicationJobs
  • GetReplicationRuns
  • GetServers

Operations

CreateApp

$result = $client->createApp([/* ... */]);
$promise = $client->createAppAsync([/* ... */]);

Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.

Parameter Syntax

$result = $client->createApp([
    'clientToken' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'roleName' => '<string>',
    'serverGroups' => [
        [
            'name' => '<string>',
            'serverGroupId' => '<string>',
            'serverList' => [
                [
                    'replicationJobId' => '<string>',
                    'replicationJobTerminated' => true || false,
                    'serverId' => '<string>',
                    'serverType' => 'VIRTUAL_MACHINE',
                    'vmServer' => [
                        'vmManagerName' => '<string>',
                        'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                        'vmName' => '<string>',
                        'vmPath' => '<string>',
                        'vmServerAddress' => [
                            'vmId' => '<string>',
                            'vmManagerId' => '<string>',
                        ],
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
clientToken
  • Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of application creation.

description
  • Type: string

The description of the new application

name
  • Type: string

The name of the new application.

roleName
  • Type: string

The name of the service role in the customer's account to be used by Server Migration Service.

serverGroups
  • Type: Array of ServerGroup structures

The server groups to include in the application.

tags
  • Type: Array of Tag structures

The tags to be associated with the application.

Result Syntax

[
    'appSummary' => [
        'appId' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'importedAppId' => '<string>',
        'lastModified' => <DateTime>,
        'latestReplicationTime' => <DateTime>,
        'launchConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
        'launchDetails' => [
            'latestLaunchTime' => <DateTime>,
            'stackId' => '<string>',
            'stackName' => '<string>',
        ],
        'launchStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_LAUNCH|VALIDATION_IN_PROGRESS|LAUNCH_PENDING|LAUNCH_IN_PROGRESS|LAUNCHED|PARTIALLY_LAUNCHED|DELTA_LAUNCH_IN_PROGRESS|DELTA_LAUNCH_FAILED|LAUNCH_FAILED|TERMINATE_IN_PROGRESS|TERMINATE_FAILED|TERMINATED',
        'launchStatusMessage' => '<string>',
        'name' => '<string>',
        'replicationConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
        'replicationStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_REPLICATION|VALIDATION_IN_PROGRESS|REPLICATION_PENDING|REPLICATION_IN_PROGRESS|REPLICATED|PARTIALLY_REPLICATED|DELTA_REPLICATION_IN_PROGRESS|DELTA_REPLICATED|DELTA_REPLICATION_FAILED|REPLICATION_FAILED|REPLICATION_STOPPING|REPLICATION_STOP_FAILED|REPLICATION_STOPPED',
        'replicationStatusMessage' => '<string>',
        'roleName' => '<string>',
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|DELETED|DELETE_FAILED',
        'statusMessage' => '<string>',
        'totalServerGroups' => <integer>,
        'totalServers' => <integer>,
    ],
    'serverGroups' => [
        [
            'name' => '<string>',
            'serverGroupId' => '<string>',
            'serverList' => [
                [
                    'replicationJobId' => '<string>',
                    'replicationJobTerminated' => true || false,
                    'serverId' => '<string>',
                    'serverType' => 'VIRTUAL_MACHINE',
                    'vmServer' => [
                        'vmManagerName' => '<string>',
                        'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                        'vmName' => '<string>',
                        'vmPath' => '<string>',
                        'vmServerAddress' => [
                            'vmId' => '<string>',
                            'vmManagerId' => '<string>',
                        ],
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
appSummary
  • Type: AppSummary structure

A summary description of the application.

serverGroups
  • Type: Array of ServerGroup structures

The server groups included in the application.

tags
  • Type: Array of Tag structures

The tags associated with the application.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

CreateReplicationJob

$result = $client->createReplicationJob([/* ... */]);
$promise = $client->createReplicationJobAsync([/* ... */]);

Creates a replication job. The replication job schedules periodic replication runs to replicate your server to Amazon Web Services. Each replication run creates an Amazon Machine Image (AMI).

Parameter Syntax

$result = $client->createReplicationJob([
    'description' => '<string>',
    'encrypted' => true || false,
    'frequency' => <integer>,
    'kmsKeyId' => '<string>',
    'licenseType' => 'AWS|BYOL',
    'numberOfRecentAmisToKeep' => <integer>,
    'roleName' => '<string>',
    'runOnce' => true || false,
    'seedReplicationTime' => <integer || string || DateTime>, // REQUIRED
    'serverId' => '<string>', // REQUIRED
]);

Parameter Details

Members
description
  • Type: string

The description of the replication job.

encrypted
  • Type: boolean

Indicates whether the replication job produces encrypted AMIs.

frequency
  • Type: int

The time between consecutive replication runs, in hours.

kmsKeyId
  • Type: string

The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to the KMS key ID

  • ARN referring to the KMS key alias

If encrypted is true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

licenseType
  • Type: string

The license type to be used for the AMI created by a successful replication run.

numberOfRecentAmisToKeep
  • Type: int

The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.

roleName
  • Type: string

The name of the IAM role to be used by the Server Migration Service.

runOnce
  • Type: boolean

Indicates whether to run the replication job one time.

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

The seed replication time.

serverId
  • Required: Yes
  • Type: string

The ID of the server.

Result Syntax

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

Result Details

Members
replicationJobId
  • Type: string

The unique identifier of the replication job.

Errors

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • OperationNotPermittedException:

    This operation is not allowed.

  • ServerCannotBeReplicatedException:

    The specified server cannot be replicated.

  • ReplicationJobAlreadyExistsException:

    The specified replication job already exists.

  • NoConnectorsAvailableException:

    There are no connectors available.

  • InternalError:

    An internal error occurred.

  • TemporarilyUnavailableException:

    The service is temporarily unavailable.

DeleteApp

$result = $client->deleteApp([/* ... */]);
$promise = $client->deleteAppAsync([/* ... */]);

Deletes the specified application. Optionally deletes the launched stack associated with the application and all Server Migration Service replication jobs for servers in the application.

Parameter Syntax

$result = $client->deleteApp([
    'appId' => '<string>',
    'forceStopAppReplication' => true || false,
    'forceTerminateApp' => true || false,
]);

Parameter Details

Members
appId
  • Type: string

The ID of the application.

forceStopAppReplication
  • Type: boolean

Indicates whether to stop all replication jobs corresponding to the servers in the application while deleting the application.

forceTerminateApp
  • Type: boolean

Indicates whether to terminate the stack corresponding to the application while deleting the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

DeleteAppLaunchConfiguration

$result = $client->deleteAppLaunchConfiguration([/* ... */]);
$promise = $client->deleteAppLaunchConfigurationAsync([/* ... */]);

Deletes the launch configuration for the specified application.

Parameter Syntax

$result = $client->deleteAppLaunchConfiguration([
    'appId' => '<string>',
]);

Parameter Details

Members
appId
  • Type: string

The ID of the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

DeleteAppReplicationConfiguration

$result = $client->deleteAppReplicationConfiguration([/* ... */]);
$promise = $client->deleteAppReplicationConfigurationAsync([/* ... */]);

Deletes the replication configuration for the specified application.

Parameter Syntax

$result = $client->deleteAppReplicationConfiguration([
    'appId' => '<string>',
]);

Parameter Details

Members
appId
  • Type: string

The ID of the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

DeleteAppValidationConfiguration

$result = $client->deleteAppValidationConfiguration([/* ... */]);
$promise = $client->deleteAppValidationConfigurationAsync([/* ... */]);

Deletes the validation configuration for the specified application.

Parameter Syntax

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

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The ID of the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

DeleteReplicationJob

$result = $client->deleteReplicationJob([/* ... */]);
$promise = $client->deleteReplicationJobAsync([/* ... */]);

Deletes the specified replication job.

After you delete a replication job, there are no further replication runs. Amazon Web Services deletes the contents of the Amazon S3 bucket used to store Server Migration Service artifacts. The AMIs created by the replication runs are not deleted.

Parameter Syntax

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

Parameter Details

Members
replicationJobId
  • Required: Yes
  • Type: string

The ID of the replication job.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • OperationNotPermittedException:

    This operation is not allowed.

  • ReplicationJobNotFoundException:

    The specified replication job does not exist.

DeleteServerCatalog

$result = $client->deleteServerCatalog([/* ... */]);
$promise = $client->deleteServerCatalogAsync([/* ... */]);

Deletes all servers from your server catalog.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • OperationNotPermittedException:

    This operation is not allowed.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

DisassociateConnector

$result = $client->disassociateConnector([/* ... */]);
$promise = $client->disassociateConnectorAsync([/* ... */]);

Disassociates the specified connector from Server Migration Service.

After you disassociate a connector, it is no longer available to support replication jobs.

Parameter Syntax

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

Parameter Details

Members
connectorId
  • Required: Yes
  • Type: string

The ID of the connector.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • MissingRequiredParameterException:

    A required parameter is missing.

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • OperationNotPermittedException:

    This operation is not allowed.

  • InvalidParameterException:

    A specified parameter is not valid.

GenerateChangeSet

$result = $client->generateChangeSet([/* ... */]);
$promise = $client->generateChangeSetAsync([/* ... */]);

Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

Parameter Syntax

$result = $client->generateChangeSet([
    'appId' => '<string>',
    'changesetFormat' => 'JSON|YAML',
]);

Parameter Details

Members
appId
  • Type: string

The ID of the application associated with the change set.

changesetFormat
  • Type: string

The format for the change set.

Result Syntax

[
    's3Location' => [
        'bucket' => '<string>',
        'key' => '<string>',
    ],
]

Result Details

Members
s3Location
  • Type: S3Location structure

The location of the Amazon S3 object.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

GenerateTemplate

$result = $client->generateTemplate([/* ... */]);
$promise = $client->generateTemplateAsync([/* ... */]);

Generates an CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

Parameter Syntax

$result = $client->generateTemplate([
    'appId' => '<string>',
    'templateFormat' => 'JSON|YAML',
]);

Parameter Details

Members
appId
  • Type: string

The ID of the application associated with the CloudFormation template.

templateFormat
  • Type: string

The format for generating the CloudFormation template.

Result Syntax

[
    's3Location' => [
        'bucket' => '<string>',
        'key' => '<string>',
    ],
]

Result Details

Members
s3Location
  • Type: S3Location structure

The location of the Amazon S3 object.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

GetApp

$result = $client->getApp([/* ... */]);
$promise = $client->getAppAsync([/* ... */]);

Retrieve information about the specified application.

Parameter Syntax

$result = $client->getApp([
    'appId' => '<string>',
]);

Parameter Details

Members
appId
  • Type: string

The ID of the application.

Result Syntax

[
    'appSummary' => [
        'appId' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'importedAppId' => '<string>',
        'lastModified' => <DateTime>,
        'latestReplicationTime' => <DateTime>,
        'launchConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
        'launchDetails' => [
            'latestLaunchTime' => <DateTime>,
            'stackId' => '<string>',
            'stackName' => '<string>',
        ],
        'launchStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_LAUNCH|VALIDATION_IN_PROGRESS|LAUNCH_PENDING|LAUNCH_IN_PROGRESS|LAUNCHED|PARTIALLY_LAUNCHED|DELTA_LAUNCH_IN_PROGRESS|DELTA_LAUNCH_FAILED|LAUNCH_FAILED|TERMINATE_IN_PROGRESS|TERMINATE_FAILED|TERMINATED',
        'launchStatusMessage' => '<string>',
        'name' => '<string>',
        'replicationConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
        'replicationStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_REPLICATION|VALIDATION_IN_PROGRESS|REPLICATION_PENDING|REPLICATION_IN_PROGRESS|REPLICATED|PARTIALLY_REPLICATED|DELTA_REPLICATION_IN_PROGRESS|DELTA_REPLICATED|DELTA_REPLICATION_FAILED|REPLICATION_FAILED|REPLICATION_STOPPING|REPLICATION_STOP_FAILED|REPLICATION_STOPPED',
        'replicationStatusMessage' => '<string>',
        'roleName' => '<string>',
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|DELETED|DELETE_FAILED',
        'statusMessage' => '<string>',
        'totalServerGroups' => <integer>,
        'totalServers' => <integer>,
    ],
    'serverGroups' => [
        [
            'name' => '<string>',
            'serverGroupId' => '<string>',
            'serverList' => [
                [
                    'replicationJobId' => '<string>',
                    'replicationJobTerminated' => true || false,
                    'serverId' => '<string>',
                    'serverType' => 'VIRTUAL_MACHINE',
                    'vmServer' => [
                        'vmManagerName' => '<string>',
                        'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                        'vmName' => '<string>',
                        'vmPath' => '<string>',
                        'vmServerAddress' => [
                            'vmId' => '<string>',
                            'vmManagerId' => '<string>',
                        ],
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
appSummary
  • Type: AppSummary structure

Information about the application.

serverGroups
  • Type: Array of ServerGroup structures

The server groups that belong to the application.

tags
  • Type: Array of Tag structures

The tags associated with the application.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

GetAppLaunchConfiguration

$result = $client->getAppLaunchConfiguration([/* ... */]);
$promise = $client->getAppLaunchConfigurationAsync([/* ... */]);

Retrieves the application launch configuration associated with the specified application.

Parameter Syntax

$result = $client->getAppLaunchConfiguration([
    'appId' => '<string>',
]);

Parameter Details

Members
appId
  • Type: string

The ID of the application.

Result Syntax

[
    'appId' => '<string>',
    'autoLaunch' => true || false,
    'roleName' => '<string>',
    'serverGroupLaunchConfigurations' => [
        [
            'launchOrder' => <integer>,
            'serverGroupId' => '<string>',
            'serverLaunchConfigurations' => [
                [
                    'associatePublicIpAddress' => true || false,
                    'configureScript' => [
                        'bucket' => '<string>',
                        'key' => '<string>',
                    ],
                    'configureScriptType' => 'SHELL_SCRIPT|POWERSHELL_SCRIPT',
                    'ec2KeyName' => '<string>',
                    'iamInstanceProfileName' => '<string>',
                    'instanceType' => '<string>',
                    'logicalId' => '<string>',
                    'securityGroup' => '<string>',
                    'server' => [
                        'replicationJobId' => '<string>',
                        'replicationJobTerminated' => true || false,
                        'serverId' => '<string>',
                        'serverType' => 'VIRTUAL_MACHINE',
                        'vmServer' => [
                            'vmManagerName' => '<string>',
                            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                            'vmName' => '<string>',
                            'vmPath' => '<string>',
                            'vmServerAddress' => [
                                'vmId' => '<string>',
                                'vmManagerId' => '<string>',
                            ],
                        ],
                    ],
                    'subnet' => '<string>',
                    'userData' => [
                        's3Location' => [
                            'bucket' => '<string>',
                            'key' => '<string>',
                        ],
                    ],
                    'vpc' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
appId
  • Type: string

The ID of the application.

autoLaunch
  • Type: boolean

Indicates whether the application is configured to launch automatically after replication is complete.

roleName
  • Type: string

The name of the service role in the customer's account that CloudFormation uses to launch the application.

serverGroupLaunchConfigurations
  • Type: Array of ServerGroupLaunchConfiguration structures

The launch configurations for server groups in this application.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

GetAppReplicationConfiguration

$result = $client->getAppReplicationConfiguration([/* ... */]);
$promise = $client->getAppReplicationConfigurationAsync([/* ... */]);

Retrieves the application replication configuration associated with the specified application.

Parameter Syntax

$result = $client->getAppReplicationConfiguration([
    'appId' => '<string>',
]);

Parameter Details

Members
appId
  • Type: string

The ID of the application.

Result Syntax

[
    'serverGroupReplicationConfigurations' => [
        [
            'serverGroupId' => '<string>',
            'serverReplicationConfigurations' => [
                [
                    'server' => [
                        'replicationJobId' => '<string>',
                        'replicationJobTerminated' => true || false,
                        'serverId' => '<string>',
                        'serverType' => 'VIRTUAL_MACHINE',
                        'vmServer' => [
                            'vmManagerName' => '<string>',
                            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                            'vmName' => '<string>',
                            'vmPath' => '<string>',
                            'vmServerAddress' => [
                                'vmId' => '<string>',
                                'vmManagerId' => '<string>',
                            ],
                        ],
                    ],
                    'serverReplicationParameters' => [
                        'encrypted' => true || false,
                        'frequency' => <integer>,
                        'kmsKeyId' => '<string>',
                        'licenseType' => 'AWS|BYOL',
                        'numberOfRecentAmisToKeep' => <integer>,
                        'runOnce' => true || false,
                        'seedTime' => <DateTime>,
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
serverGroupReplicationConfigurations
  • Type: Array of ServerGroupReplicationConfiguration structures

The replication configurations associated with server groups in this application.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

GetAppValidationConfiguration

$result = $client->getAppValidationConfiguration([/* ... */]);
$promise = $client->getAppValidationConfigurationAsync([/* ... */]);

Retrieves information about a configuration for validating an application.

Parameter Syntax

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

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The ID of the application.

Result Syntax

[
    'appValidationConfigurations' => [
        [
            'appValidationStrategy' => 'SSM',
            'name' => '<string>',
            'ssmValidationParameters' => [
                'command' => '<string>',
                'executionTimeoutSeconds' => <integer>,
                'instanceId' => '<string>',
                'outputS3BucketName' => '<string>',
                'scriptType' => 'SHELL_SCRIPT|POWERSHELL_SCRIPT',
                'source' => [
                    's3Location' => [
                        'bucket' => '<string>',
                        'key' => '<string>',
                    ],
                ],
            ],
            'validationId' => '<string>',
        ],
        // ...
    ],
    'serverGroupValidationConfigurations' => [
        [
            'serverGroupId' => '<string>',
            'serverValidationConfigurations' => [
                [
                    'name' => '<string>',
                    'server' => [
                        'replicationJobId' => '<string>',
                        'replicationJobTerminated' => true || false,
                        'serverId' => '<string>',
                        'serverType' => 'VIRTUAL_MACHINE',
                        'vmServer' => [
                            'vmManagerName' => '<string>',
                            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                            'vmName' => '<string>',
                            'vmPath' => '<string>',
                            'vmServerAddress' => [
                                'vmId' => '<string>',
                                'vmManagerId' => '<string>',
                            ],
                        ],
                    ],
                    'serverValidationStrategy' => 'USERDATA',
                    'userDataValidationParameters' => [
                        'scriptType' => 'SHELL_SCRIPT|POWERSHELL_SCRIPT',
                        'source' => [
                            's3Location' => [
                                'bucket' => '<string>',
                                'key' => '<string>',
                            ],
                        ],
                    ],
                    'validationId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
appValidationConfigurations
  • Type: Array of AppValidationConfiguration structures

The configuration for application validation.

serverGroupValidationConfigurations
  • Type: Array of ServerGroupValidationConfiguration structures

The configuration for instance validation.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

GetAppValidationOutput

$result = $client->getAppValidationOutput([/* ... */]);
$promise = $client->getAppValidationOutputAsync([/* ... */]);

Retrieves output from validating an application.

Parameter Syntax

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

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The ID of the application.

Result Syntax

[
    'validationOutputList' => [
        [
            'appValidationOutput' => [
                'ssmOutput' => [
                    's3Location' => [
                        'bucket' => '<string>',
                        'key' => '<string>',
                    ],
                ],
            ],
            'latestValidationTime' => <DateTime>,
            'name' => '<string>',
            'serverValidationOutput' => [
                'server' => [
                    'replicationJobId' => '<string>',
                    'replicationJobTerminated' => true || false,
                    'serverId' => '<string>',
                    'serverType' => 'VIRTUAL_MACHINE',
                    'vmServer' => [
                        'vmManagerName' => '<string>',
                        'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                        'vmName' => '<string>',
                        'vmPath' => '<string>',
                        'vmServerAddress' => [
                            'vmId' => '<string>',
                            'vmManagerId' => '<string>',
                        ],
                    ],
                ],
            ],
            'status' => 'READY_FOR_VALIDATION|PENDING|IN_PROGRESS|SUCCEEDED|FAILED',
            'statusMessage' => '<string>',
            'validationId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
validationOutputList
  • Type: Array of ValidationOutput structures

The validation output.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

GetConnectors

$result = $client->getConnectors([/* ... */]);
$promise = $client->getConnectorsAsync([/* ... */]);

Describes the connectors registered with the Server Migration Service.

Parameter Syntax

$result = $client->getConnectors([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
  • Type: int

The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken
  • Type: string

The token for the next set of results.

Result Syntax

[
    'connectorList' => [
        [
            'associatedOn' => <DateTime>,
            'capabilityList' => ['<string>', ...],
            'connectorId' => '<string>',
            'ipAddress' => '<string>',
            'macAddress' => '<string>',
            'status' => 'HEALTHY|UNHEALTHY',
            'version' => '<string>',
            'vmManagerId' => '<string>',
            'vmManagerName' => '<string>',
            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
connectorList
  • Type: Array of Connector structures

Information about the registered connectors.

nextToken
  • Type: string

The token required to retrieve the next set of results. This value is null when there are no more results to return.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

GetReplicationJobs

$result = $client->getReplicationJobs([/* ... */]);
$promise = $client->getReplicationJobsAsync([/* ... */]);

Describes the specified replication job or all of your replication jobs.

Parameter Syntax

$result = $client->getReplicationJobs([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'replicationJobId' => '<string>',
]);

Parameter Details

Members
maxResults
  • Type: int

The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken
  • Type: string

The token for the next set of results.

replicationJobId
  • Type: string

The ID of the replication job.

Result Syntax

[
    'nextToken' => '<string>',
    'replicationJobList' => [
        [
            'description' => '<string>',
            'encrypted' => true || false,
            'frequency' => <integer>,
            'kmsKeyId' => '<string>',
            'latestAmiId' => '<string>',
            'licenseType' => 'AWS|BYOL',
            'nextReplicationRunStartTime' => <DateTime>,
            'numberOfRecentAmisToKeep' => <integer>,
            'replicationJobId' => '<string>',
            'replicationRunList' => [
                [
                    'amiId' => '<string>',
                    'completedTime' => <DateTime>,
                    'description' => '<string>',
                    'encrypted' => true || false,
                    'kmsKeyId' => '<string>',
                    'replicationRunId' => '<string>',
                    'scheduledStartTime' => <DateTime>,
                    'stageDetails' => [
                        'stage' => '<string>',
                        'stageProgress' => '<string>',
                    ],
                    'state' => 'PENDING|MISSED|ACTIVE|FAILED|COMPLETED|DELETING|DELETED',
                    'statusMessage' => '<string>',
                    'type' => 'ON_DEMAND|AUTOMATIC',
                ],
                // ...
            ],
            'roleName' => '<string>',
            'runOnce' => true || false,
            'seedReplicationTime' => <DateTime>,
            'serverId' => '<string>',
            'serverType' => 'VIRTUAL_MACHINE',
            'state' => 'PENDING|ACTIVE|FAILED|DELETING|DELETED|COMPLETED|PAUSED_ON_FAILURE|FAILING',
            'statusMessage' => '<string>',
            'vmServer' => [
                'vmManagerName' => '<string>',
                'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                'vmName' => '<string>',
                'vmPath' => '<string>',
                'vmServerAddress' => [
                    'vmId' => '<string>',
                    'vmManagerId' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The token required to retrieve the next set of results. This value is null when there are no more results to return.

replicationJobList
  • Type: Array of ReplicationJob structures

Information about the replication jobs.

Errors

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

GetReplicationRuns

$result = $client->getReplicationRuns([/* ... */]);
$promise = $client->getReplicationRunsAsync([/* ... */]);

Describes the replication runs for the specified replication job.

Parameter Syntax

$result = $client->getReplicationRuns([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'replicationJobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
  • Type: int

The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken
  • Type: string

The token for the next set of results.

replicationJobId
  • Required: Yes
  • Type: string

The ID of the replication job.

Result Syntax

[
    'nextToken' => '<string>',
    'replicationJob' => [
        'description' => '<string>',
        'encrypted' => true || false,
        'frequency' => <integer>,
        'kmsKeyId' => '<string>',
        'latestAmiId' => '<string>',
        'licenseType' => 'AWS|BYOL',
        'nextReplicationRunStartTime' => <DateTime>,
        'numberOfRecentAmisToKeep' => <integer>,
        'replicationJobId' => '<string>',
        'replicationRunList' => [
            [
                'amiId' => '<string>',
                'completedTime' => <DateTime>,
                'description' => '<string>',
                'encrypted' => true || false,
                'kmsKeyId' => '<string>',
                'replicationRunId' => '<string>',
                'scheduledStartTime' => <DateTime>,
                'stageDetails' => [
                    'stage' => '<string>',
                    'stageProgress' => '<string>',
                ],
                'state' => 'PENDING|MISSED|ACTIVE|FAILED|COMPLETED|DELETING|DELETED',
                'statusMessage' => '<string>',
                'type' => 'ON_DEMAND|AUTOMATIC',
            ],
            // ...
        ],
        'roleName' => '<string>',
        'runOnce' => true || false,
        'seedReplicationTime' => <DateTime>,
        'serverId' => '<string>',
        'serverType' => 'VIRTUAL_MACHINE',
        'state' => 'PENDING|ACTIVE|FAILED|DELETING|DELETED|COMPLETED|PAUSED_ON_FAILURE|FAILING',
        'statusMessage' => '<string>',
        'vmServer' => [
            'vmManagerName' => '<string>',
            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
            'vmName' => '<string>',
            'vmPath' => '<string>',
            'vmServerAddress' => [
                'vmId' => '<string>',
                'vmManagerId' => '<string>',
            ],
        ],
    ],
    'replicationRunList' => [
        [
            'amiId' => '<string>',
            'completedTime' => <DateTime>,
            'description' => '<string>',
            'encrypted' => true || false,
            'kmsKeyId' => '<string>',
            'replicationRunId' => '<string>',
            'scheduledStartTime' => <DateTime>,
            'stageDetails' => [
                'stage' => '<string>',
                'stageProgress' => '<string>',
            ],
            'state' => 'PENDING|MISSED|ACTIVE|FAILED|COMPLETED|DELETING|DELETED',
            'statusMessage' => '<string>',
            'type' => 'ON_DEMAND|AUTOMATIC',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The token required to retrieve the next set of results. This value is null when there are no more results to return.

replicationJob
  • Type: ReplicationJob structure

Information about the replication job.

replicationRunList
  • Type: Array of ReplicationRun structures

Information about the replication runs.

Errors

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

GetServers

$result = $client->getServers([/* ... */]);
$promise = $client->getServersAsync([/* ... */]);

Describes the servers in your server catalog.

Before you can describe your servers, you must import them using ImportServerCatalog.

Parameter Syntax

$result = $client->getServers([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'vmServerAddressList' => [
        [
            'vmId' => '<string>',
            'vmManagerId' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
maxResults
  • Type: int

The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken
  • Type: string

The token for the next set of results.

vmServerAddressList
  • Type: Array of VmServerAddress structures

The server addresses.

Result Syntax

[
    'lastModifiedOn' => <DateTime>,
    'nextToken' => '<string>',
    'serverCatalogStatus' => 'NOT_IMPORTED|IMPORTING|AVAILABLE|DELETED|EXPIRED',
    'serverList' => [
        [
            'replicationJobId' => '<string>',
            'replicationJobTerminated' => true || false,
            'serverId' => '<string>',
            'serverType' => 'VIRTUAL_MACHINE',
            'vmServer' => [
                'vmManagerName' => '<string>',
                'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                'vmName' => '<string>',
                'vmPath' => '<string>',
                'vmServerAddress' => [
                    'vmId' => '<string>',
                    'vmManagerId' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

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

The time when the server was last modified.

nextToken
  • Type: string

The token required to retrieve the next set of results. This value is null when there are no more results to return.

serverCatalogStatus
  • Type: string

The status of the server catalog.

serverList
  • Type: Array of Server structures

Information about the servers.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

ImportAppCatalog

$result = $client->importAppCatalog([/* ... */]);
$promise = $client->importAppCatalogAsync([/* ... */]);

Allows application import from Migration Hub.

Parameter Syntax

$result = $client->importAppCatalog([
    'roleName' => '<string>',
]);

Parameter Details

Members
roleName
  • Type: string

The name of the service role. If you omit this parameter, we create a service-linked role for Migration Hub in your account. Otherwise, the role that you provide must have the policy and trust policy described in the Migration Hub User Guide.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

ImportServerCatalog

$result = $client->importServerCatalog([/* ... */]);
$promise = $client->importServerCatalogAsync([/* ... */]);

Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers to import.

This call returns immediately, but might take additional time to retrieve all the servers.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • OperationNotPermittedException:

    This operation is not allowed.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • NoConnectorsAvailableException:

    There are no connectors available.

LaunchApp

$result = $client->launchApp([/* ... */]);
$promise = $client->launchAppAsync([/* ... */]);

Launches the specified application as a stack in CloudFormation.

Parameter Syntax

$result = $client->launchApp([
    'appId' => '<string>',
]);

Parameter Details

Members
appId
  • Type: string

The ID of the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

ListApps

$result = $client->listApps([/* ... */]);
$promise = $client->listAppsAsync([/* ... */]);

Retrieves summaries for all applications.

Parameter Syntax

$result = $client->listApps([
    'appIds' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
appIds
  • Type: Array of strings

The unique application IDs.

maxResults
  • Type: int

The maximum number of results to return in a single call. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken
  • Type: string

The token for the next set of results.

Result Syntax

[
    'apps' => [
        [
            'appId' => '<string>',
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'importedAppId' => '<string>',
            'lastModified' => <DateTime>,
            'latestReplicationTime' => <DateTime>,
            'launchConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
            'launchDetails' => [
                'latestLaunchTime' => <DateTime>,
                'stackId' => '<string>',
                'stackName' => '<string>',
            ],
            'launchStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_LAUNCH|VALIDATION_IN_PROGRESS|LAUNCH_PENDING|LAUNCH_IN_PROGRESS|LAUNCHED|PARTIALLY_LAUNCHED|DELTA_LAUNCH_IN_PROGRESS|DELTA_LAUNCH_FAILED|LAUNCH_FAILED|TERMINATE_IN_PROGRESS|TERMINATE_FAILED|TERMINATED',
            'launchStatusMessage' => '<string>',
            'name' => '<string>',
            'replicationConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
            'replicationStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_REPLICATION|VALIDATION_IN_PROGRESS|REPLICATION_PENDING|REPLICATION_IN_PROGRESS|REPLICATED|PARTIALLY_REPLICATED|DELTA_REPLICATION_IN_PROGRESS|DELTA_REPLICATED|DELTA_REPLICATION_FAILED|REPLICATION_FAILED|REPLICATION_STOPPING|REPLICATION_STOP_FAILED|REPLICATION_STOPPED',
            'replicationStatusMessage' => '<string>',
            'roleName' => '<string>',
            'status' => 'CREATING|ACTIVE|UPDATING|DELETING|DELETED|DELETE_FAILED',
            'statusMessage' => '<string>',
            'totalServerGroups' => <integer>,
            'totalServers' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
apps
  • Type: Array of AppSummary structures

The application summaries.

nextToken
  • Type: string

The token required to retrieve the next set of results. This value is null when there are no more results to return.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

NotifyAppValidationOutput

$result = $client->notifyAppValidationOutput([/* ... */]);
$promise = $client->notifyAppValidationOutputAsync([/* ... */]);

Provides information to Server Migration Service about whether application validation is successful.

Parameter Syntax

$result = $client->notifyAppValidationOutput([
    'appId' => '<string>', // REQUIRED
    'notificationContext' => [
        'status' => 'READY_FOR_VALIDATION|PENDING|IN_PROGRESS|SUCCEEDED|FAILED',
        'statusMessage' => '<string>',
        'validationId' => '<string>',
    ],
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The ID of the application.

notificationContext
  • Type: NotificationContext structure

The notification information.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

PutAppLaunchConfiguration

$result = $client->putAppLaunchConfiguration([/* ... */]);
$promise = $client->putAppLaunchConfigurationAsync([/* ... */]);

Creates or updates the launch configuration for the specified application.

Parameter Syntax

$result = $client->putAppLaunchConfiguration([
    'appId' => '<string>',
    'autoLaunch' => true || false,
    'roleName' => '<string>',
    'serverGroupLaunchConfigurations' => [
        [
            'launchOrder' => <integer>,
            'serverGroupId' => '<string>',
            'serverLaunchConfigurations' => [
                [
                    'associatePublicIpAddress' => true || false,
                    'configureScript' => [
                        'bucket' => '<string>',
                        'key' => '<string>',
                    ],
                    'configureScriptType' => 'SHELL_SCRIPT|POWERSHELL_SCRIPT',
                    'ec2KeyName' => '<string>',
                    'iamInstanceProfileName' => '<string>',
                    'instanceType' => '<string>',
                    'logicalId' => '<string>',
                    'securityGroup' => '<string>',
                    'server' => [
                        'replicationJobId' => '<string>',
                        'replicationJobTerminated' => true || false,
                        'serverId' => '<string>',
                        'serverType' => 'VIRTUAL_MACHINE',
                        'vmServer' => [
                            'vmManagerName' => '<string>',
                            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                            'vmName' => '<string>',
                            'vmPath' => '<string>',
                            'vmServerAddress' => [
                                'vmId' => '<string>',
                                'vmManagerId' => '<string>',
                            ],
                        ],
                    ],
                    'subnet' => '<string>',
                    'userData' => [
                        's3Location' => [
                            'bucket' => '<string>',
                            'key' => '<string>',
                        ],
                    ],
                    'vpc' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
appId
  • Type: string

The ID of the application.

autoLaunch
  • Type: boolean

Indicates whether the application is configured to launch automatically after replication is complete.

roleName
  • Type: string

The name of service role in the customer's account that CloudFormation uses to launch the application.

serverGroupLaunchConfigurations
  • Type: Array of ServerGroupLaunchConfiguration structures

Information about the launch configurations for server groups in the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

PutAppReplicationConfiguration

$result = $client->putAppReplicationConfiguration([/* ... */]);
$promise = $client->putAppReplicationConfigurationAsync([/* ... */]);

Creates or updates the replication configuration for the specified application.

Parameter Syntax

$result = $client->putAppReplicationConfiguration([
    'appId' => '<string>',
    'serverGroupReplicationConfigurations' => [
        [
            'serverGroupId' => '<string>',
            'serverReplicationConfigurations' => [
                [
                    'server' => [
                        'replicationJobId' => '<string>',
                        'replicationJobTerminated' => true || false,
                        'serverId' => '<string>',
                        'serverType' => 'VIRTUAL_MACHINE',
                        'vmServer' => [
                            'vmManagerName' => '<string>',
                            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                            'vmName' => '<string>',
                            'vmPath' => '<string>',
                            'vmServerAddress' => [
                                'vmId' => '<string>',
                                'vmManagerId' => '<string>',
                            ],
                        ],
                    ],
                    'serverReplicationParameters' => [
                        'encrypted' => true || false,
                        'frequency' => <integer>,
                        'kmsKeyId' => '<string>',
                        'licenseType' => 'AWS|BYOL',
                        'numberOfRecentAmisToKeep' => <integer>,
                        'runOnce' => true || false,
                        'seedTime' => <integer || string || DateTime>,
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
appId
  • Type: string

The ID of the application.

serverGroupReplicationConfigurations
  • Type: Array of ServerGroupReplicationConfiguration structures

Information about the replication configurations for server groups in the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

PutAppValidationConfiguration

$result = $client->putAppValidationConfiguration([/* ... */]);
$promise = $client->putAppValidationConfigurationAsync([/* ... */]);

Creates or updates a validation configuration for the specified application.

Parameter Syntax

$result = $client->putAppValidationConfiguration([
    'appId' => '<string>', // REQUIRED
    'appValidationConfigurations' => [
        [
            'appValidationStrategy' => 'SSM',
            'name' => '<string>',
            'ssmValidationParameters' => [
                'command' => '<string>',
                'executionTimeoutSeconds' => <integer>,
                'instanceId' => '<string>',
                'outputS3BucketName' => '<string>',
                'scriptType' => 'SHELL_SCRIPT|POWERSHELL_SCRIPT',
                'source' => [
                    's3Location' => [
                        'bucket' => '<string>',
                        'key' => '<string>',
                    ],
                ],
            ],
            'validationId' => '<string>',
        ],
        // ...
    ],
    'serverGroupValidationConfigurations' => [
        [
            'serverGroupId' => '<string>',
            'serverValidationConfigurations' => [
                [
                    'name' => '<string>',
                    'server' => [
                        'replicationJobId' => '<string>',
                        'replicationJobTerminated' => true || false,
                        'serverId' => '<string>',
                        'serverType' => 'VIRTUAL_MACHINE',
                        'vmServer' => [
                            'vmManagerName' => '<string>',
                            'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                            'vmName' => '<string>',
                            'vmPath' => '<string>',
                            'vmServerAddress' => [
                                'vmId' => '<string>',
                                'vmManagerId' => '<string>',
                            ],
                        ],
                    ],
                    'serverValidationStrategy' => 'USERDATA',
                    'userDataValidationParameters' => [
                        'scriptType' => 'SHELL_SCRIPT|POWERSHELL_SCRIPT',
                        'source' => [
                            's3Location' => [
                                'bucket' => '<string>',
                                'key' => '<string>',
                            ],
                        ],
                    ],
                    'validationId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The ID of the application.

appValidationConfigurations
  • Type: Array of AppValidationConfiguration structures

The configuration for application validation.

serverGroupValidationConfigurations
  • Type: Array of ServerGroupValidationConfiguration structures

The configuration for instance validation.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

StartAppReplication

$result = $client->startAppReplication([/* ... */]);
$promise = $client->startAppReplicationAsync([/* ... */]);

Starts replicating the specified application by creating replication jobs for each server in the application.

Parameter Syntax

$result = $client->startAppReplication([
    'appId' => '<string>',
]);

Parameter Details

Members
appId
  • Type: string

The ID of the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

StartOnDemandAppReplication

$result = $client->startOnDemandAppReplication([/* ... */]);
$promise = $client->startOnDemandAppReplicationAsync([/* ... */]);

Starts an on-demand replication run for the specified application.

Parameter Syntax

$result = $client->startOnDemandAppReplication([
    'appId' => '<string>', // REQUIRED
    'description' => '<string>',
]);

Parameter Details

Members
appId
  • Required: Yes
  • Type: string

The ID of the application.

description
  • Type: string

The description of the replication run.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

StartOnDemandReplicationRun

$result = $client->startOnDemandReplicationRun([/* ... */]);
$promise = $client->startOnDemandReplicationRunAsync([/* ... */]);

Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled.

There is a limit on the number of on-demand replications runs that you can request in a 24-hour period.

Parameter Syntax

$result = $client->startOnDemandReplicationRun([
    'description' => '<string>',
    'replicationJobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
description
  • Type: string

The description of the replication run.

replicationJobId
  • Required: Yes
  • Type: string

The ID of the replication job.

Result Syntax

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

Result Details

Members
replicationRunId
  • Type: string

The ID of the replication run.

Errors

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • OperationNotPermittedException:

    This operation is not allowed.

  • ReplicationRunLimitExceededException:

    You have exceeded the number of on-demand replication runs you can request in a 24-hour period.

  • DryRunOperationException:

    The user has the required permissions, so the request would have succeeded, but a dry run was performed.

StopAppReplication

$result = $client->stopAppReplication([/* ... */]);
$promise = $client->stopAppReplicationAsync([/* ... */]);

Stops replicating the specified application by deleting the replication job for each server in the application.

Parameter Syntax

$result = $client->stopAppReplication([
    'appId' => '<string>',
]);

Parameter Details

Members
appId
  • Type: string

The ID of the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

TerminateApp

$result = $client->terminateApp([/* ... */]);
$promise = $client->terminateAppAsync([/* ... */]);

Terminates the stack for the specified application.

Parameter Syntax

$result = $client->terminateApp([
    'appId' => '<string>',
]);

Parameter Details

Members
appId
  • Type: string

The ID of the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

UpdateApp

$result = $client->updateApp([/* ... */]);
$promise = $client->updateAppAsync([/* ... */]);

Updates the specified application.

Parameter Syntax

$result = $client->updateApp([
    'appId' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'roleName' => '<string>',
    'serverGroups' => [
        [
            'name' => '<string>',
            'serverGroupId' => '<string>',
            'serverList' => [
                [
                    'replicationJobId' => '<string>',
                    'replicationJobTerminated' => true || false,
                    'serverId' => '<string>',
                    'serverType' => 'VIRTUAL_MACHINE',
                    'vmServer' => [
                        'vmManagerName' => '<string>',
                        'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                        'vmName' => '<string>',
                        'vmPath' => '<string>',
                        'vmServerAddress' => [
                            'vmId' => '<string>',
                            'vmManagerId' => '<string>',
                        ],
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
appId
  • Type: string

The ID of the application.

description
  • Type: string

The new description of the application.

name
  • Type: string

The new name of the application.

roleName
  • Type: string

The name of the service role in the customer's account used by Server Migration Service.

serverGroups
  • Type: Array of ServerGroup structures

The server groups in the application to update.

tags
  • Type: Array of Tag structures

The tags to associate with the application.

Result Syntax

[
    'appSummary' => [
        'appId' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'importedAppId' => '<string>',
        'lastModified' => <DateTime>,
        'latestReplicationTime' => <DateTime>,
        'launchConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
        'launchDetails' => [
            'latestLaunchTime' => <DateTime>,
            'stackId' => '<string>',
            'stackName' => '<string>',
        ],
        'launchStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_LAUNCH|VALIDATION_IN_PROGRESS|LAUNCH_PENDING|LAUNCH_IN_PROGRESS|LAUNCHED|PARTIALLY_LAUNCHED|DELTA_LAUNCH_IN_PROGRESS|DELTA_LAUNCH_FAILED|LAUNCH_FAILED|TERMINATE_IN_PROGRESS|TERMINATE_FAILED|TERMINATED',
        'launchStatusMessage' => '<string>',
        'name' => '<string>',
        'replicationConfigurationStatus' => 'NOT_CONFIGURED|CONFIGURED',
        'replicationStatus' => 'READY_FOR_CONFIGURATION|CONFIGURATION_IN_PROGRESS|CONFIGURATION_INVALID|READY_FOR_REPLICATION|VALIDATION_IN_PROGRESS|REPLICATION_PENDING|REPLICATION_IN_PROGRESS|REPLICATED|PARTIALLY_REPLICATED|DELTA_REPLICATION_IN_PROGRESS|DELTA_REPLICATED|DELTA_REPLICATION_FAILED|REPLICATION_FAILED|REPLICATION_STOPPING|REPLICATION_STOP_FAILED|REPLICATION_STOPPED',
        'replicationStatusMessage' => '<string>',
        'roleName' => '<string>',
        'status' => 'CREATING|ACTIVE|UPDATING|DELETING|DELETED|DELETE_FAILED',
        'statusMessage' => '<string>',
        'totalServerGroups' => <integer>,
        'totalServers' => <integer>,
    ],
    'serverGroups' => [
        [
            'name' => '<string>',
            'serverGroupId' => '<string>',
            'serverList' => [
                [
                    'replicationJobId' => '<string>',
                    'replicationJobTerminated' => true || false,
                    'serverId' => '<string>',
                    'serverType' => 'VIRTUAL_MACHINE',
                    'vmServer' => [
                        'vmManagerName' => '<string>',
                        'vmManagerType' => 'VSPHERE|SCVMM|HYPERV-MANAGER',
                        'vmName' => '<string>',
                        'vmPath' => '<string>',
                        'vmServerAddress' => [
                            'vmId' => '<string>',
                            'vmManagerId' => '<string>',
                        ],
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
appSummary
  • Type: AppSummary structure

A summary description of the application.

serverGroups
  • Type: Array of ServerGroup structures

The updated server groups in the application.

tags
  • Type: Array of Tag structures

The tags associated with the application.

Errors

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • InternalError:

    An internal error occurred.

  • OperationNotPermittedException:

    This operation is not allowed.

UpdateReplicationJob

$result = $client->updateReplicationJob([/* ... */]);
$promise = $client->updateReplicationJobAsync([/* ... */]);

Updates the specified settings for the specified replication job.

Parameter Syntax

$result = $client->updateReplicationJob([
    'description' => '<string>',
    'encrypted' => true || false,
    'frequency' => <integer>,
    'kmsKeyId' => '<string>',
    'licenseType' => 'AWS|BYOL',
    'nextReplicationRunStartTime' => <integer || string || DateTime>,
    'numberOfRecentAmisToKeep' => <integer>,
    'replicationJobId' => '<string>', // REQUIRED
    'roleName' => '<string>',
]);

Parameter Details

Members
description
  • Type: string

The description of the replication job.

encrypted
  • Type: boolean

When true, the replication job produces encrypted AMIs. For more information, KmsKeyId.

frequency
  • Type: int

The time between consecutive replication runs, in hours.

kmsKeyId
  • Type: string

The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to the KMS key ID

  • ARN referring to the KMS key alias

If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

licenseType
  • Type: string

The license type to be used for the AMI created by a successful replication run.

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

The start time of the next replication run.

numberOfRecentAmisToKeep
  • Type: int

The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.

replicationJobId
  • Required: Yes
  • Type: string

The ID of the replication job.

roleName
  • Type: string

The name of the IAM role to be used by Server Migration Service.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidParameterException:

    A specified parameter is not valid.

  • MissingRequiredParameterException:

    A required parameter is missing.

  • OperationNotPermittedException:

    This operation is not allowed.

  • UnauthorizedOperationException:

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

  • ServerCannotBeReplicatedException:

    The specified server cannot be replicated.

  • ReplicationJobNotFoundException:

    The specified replication job does not exist.

  • InternalError:

    An internal error occurred.

  • TemporarilyUnavailableException:

    The service is temporarily unavailable.

Shapes

AppSummary

Description

Information about the application.

Members
appId
  • Type: string

The unique ID of the application.

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

The creation time of the application.

description
  • Type: string

The description of the application.

importedAppId
  • Type: string

The ID of the application.

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

The last modified time of the application.

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

The timestamp of the application's most recent successful replication.

launchConfigurationStatus
  • Type: string

Status of the launch configuration.

launchDetails
  • Type: LaunchDetails structure

Details about the latest launch of the application.

launchStatus
  • Type: string

The launch status of the application.

launchStatusMessage
  • Type: string

A message related to the launch status of the application.

name
  • Type: string

The name of the application.

replicationConfigurationStatus
  • Type: string

Status of the replication configuration.

replicationStatus
  • Type: string

The replication status of the application.

replicationStatusMessage
  • Type: string

A message related to the replication status of the application.

roleName
  • Type: string

The name of the service role in the customer's account used by Server Migration Service.

status
  • Type: string

Status of the application.

statusMessage
  • Type: string

A message related to the status of the application

totalServerGroups
  • Type: int

The number of server groups present in the application.

totalServers
  • Type: int

The number of servers present in the application.

AppValidationConfiguration

Description

Configuration for validating an application.

Members
appValidationStrategy
  • Type: string

The validation strategy.

name
  • Type: string

The name of the configuration.

ssmValidationParameters
  • Type: SSMValidationParameters structure

The validation parameters.

validationId
  • Type: string

The ID of the validation.

AppValidationOutput

Description

Output from validating an application.

Members
ssmOutput
  • Type: SSMOutput structure

Output from using SSM to validate the application.

Connector

Description

Represents a connector.

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

The time the connector was associated.

capabilityList
  • Type: Array of strings

The capabilities of the connector.

connectorId
  • Type: string

The ID of the connector.

ipAddress
  • Type: string

The IP address of the connector.

macAddress
  • Type: string

The MAC address of the connector.

status
  • Type: string

The status of the connector.

version
  • Type: string

The connector version.

vmManagerId
  • Type: string

The ID of the VM manager.

vmManagerName
  • Type: string

The name of the VM manager.

vmManagerType
  • Type: string

The VM management product.

DryRunOperationException

Description

The user has the required permissions, so the request would have succeeded, but a dry run was performed.

Members
message
  • Type: string

InternalError

Description

An internal error occurred.

Members
message
  • Type: string

InvalidParameterException

Description

A specified parameter is not valid.

Members
message
  • Type: string

LaunchDetails

Description

Details about the latest launch of an application.

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

The latest time that this application was launched successfully.

stackId
  • Type: string

The ID of the latest stack launched for this application.

stackName
  • Type: string

The name of the latest stack launched for this application.

MissingRequiredParameterException

Description

A required parameter is missing.

Members
message
  • Type: string

NoConnectorsAvailableException

Description

There are no connectors available.

Members
message
  • Type: string

NotificationContext

Description

Contains the status of validating an application.

Members
status
  • Type: string

The status of the validation.

statusMessage
  • Type: string

The status message.

validationId
  • Type: string

The ID of the validation.

OperationNotPermittedException

Description

This operation is not allowed.

Members
message
  • Type: string

ReplicationJob

Description

Represents a replication job.

Members
description
  • Type: string

The description of the replication job.

encrypted
  • Type: boolean

Indicates whether the replication job should produce encrypted AMIs.

frequency
  • Type: int

The time between consecutive replication runs, in hours.

kmsKeyId
  • Type: string

The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to the KMS key ID

  • ARN referring to the KMS key alias

If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

latestAmiId
  • Type: string

The ID of the latest Amazon Machine Image (AMI).

licenseType
  • Type: string

The license type to be used for the AMI created by a successful replication run.

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

The start time of the next replication run.

numberOfRecentAmisToKeep
  • Type: int

The number of recent AMIs to keep in the customer's account for a replication job. By default, the value is set to zero, meaning that all AMIs are kept.

replicationJobId
  • Type: string

The ID of the replication job.

replicationRunList
  • Type: Array of ReplicationRun structures

Information about the replication runs.

roleName
  • Type: string

The name of the IAM role to be used by Server Migration Service.

runOnce
  • Type: boolean

Indicates whether to run the replication job one time.

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

The seed replication time.

serverId
  • Type: string

The ID of the server.

serverType
  • Type: string

The type of server.

state
  • Type: string

The state of the replication job.

statusMessage
  • Type: string

The description of the current status of the replication job.

vmServer
  • Type: VmServer structure

Information about the VM server.

ReplicationJobAlreadyExistsException

Description

The specified replication job already exists.

Members
message
  • Type: string

ReplicationJobNotFoundException

Description

The specified replication job does not exist.

Members
message
  • Type: string

ReplicationRun

Description

Represents a replication run.

Members
amiId
  • Type: string

The ID of the Amazon Machine Image (AMI) from the replication run.

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

The completion time of the last replication run.

description
  • Type: string

The description of the replication run.

encrypted
  • Type: boolean

Indicates whether the replication run should produce an encrypted AMI.

kmsKeyId
  • Type: string

The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to the KMS key ID

  • ARN referring to the KMS key alias

If encrypted is true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

replicationRunId
  • Type: string

The ID of the replication run.

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

The start time of the next replication run.

stageDetails
  • Type: ReplicationRunStageDetails structure

Details about the current stage of the replication run.

state
  • Type: string

The state of the replication run.

statusMessage
  • Type: string

The description of the current status of the replication job.

type
  • Type: string

The type of replication run.

ReplicationRunLimitExceededException

Description

You have exceeded the number of on-demand replication runs you can request in a 24-hour period.

Members
message
  • Type: string

ReplicationRunStageDetails

Description

Details of the current stage of a replication run.

Members
stage
  • Type: string

The current stage of a replication run.

stageProgress
  • Type: string

The progress of the current stage of a replication run.

S3Location

Description

Location of an Amazon S3 object.

Members
bucket
  • Type: string

The Amazon S3 bucket name.

key
  • Type: string

The Amazon S3 bucket key.

SSMOutput

Description

Contains the location of validation output.

Members
s3Location
  • Type: S3Location structure

Location of an Amazon S3 object.

SSMValidationParameters

Description

Contains validation parameters.

Members
command
  • Type: string

The command to run the validation script.

executionTimeoutSeconds
  • Type: int

The timeout interval, in seconds.

instanceId
  • Type: string

The ID of the instance. The instance must have the following tag: UserForSMSApplicationValidation=true.

outputS3BucketName
  • Type: string

The name of the S3 bucket for output.

scriptType
  • Type: string

The type of validation script.

source
  • Type: Source structure

The location of the validation script.

Server

Description

Represents a server.

Members
replicationJobId
  • Type: string

The ID of the replication job.

replicationJobTerminated
  • Type: boolean

Indicates whether the replication job is deleted or failed.

serverId
  • Type: string

The ID of the server.

serverType
  • Type: string

The type of server.

vmServer
  • Type: VmServer structure

Information about the VM server.

ServerCannotBeReplicatedException

Description

The specified server cannot be replicated.

Members
message
  • Type: string

ServerGroup

Description

Logical grouping of servers.

Members
name
  • Type: string

The name of a server group.

serverGroupId
  • Type: string

The ID of a server group.

serverList
  • Type: Array of Server structures

The servers that belong to a server group.

ServerGroupLaunchConfiguration

Description

Launch configuration for a server group.

Members
launchOrder
  • Type: int

The launch order of servers in the server group.

serverGroupId
  • Type: string

The ID of the server group with which the launch configuration is associated.

serverLaunchConfigurations
  • Type: Array of ServerLaunchConfiguration structures

The launch configuration for servers in the server group.

ServerGroupReplicationConfiguration

Description

Replication configuration for a server group.

Members
serverGroupId
  • Type: string

The ID of the server group with which this replication configuration is associated.

serverReplicationConfigurations
  • Type: Array of ServerReplicationConfiguration structures

The replication configuration for servers in the server group.

ServerGroupValidationConfiguration

Description

Configuration for validating an instance.

Members
serverGroupId
  • Type: string

The ID of the server group.

serverValidationConfigurations
  • Type: Array of ServerValidationConfiguration structures

The validation configuration.

ServerLaunchConfiguration

Description

Launch configuration for a server.

Members
associatePublicIpAddress
  • Type: boolean

Indicates whether a publicly accessible IP address is created when launching the server.

configureScript
  • Type: S3Location structure

Location of an Amazon S3 object.

configureScriptType
  • Type: string

The type of configuration script.

ec2KeyName
  • Type: string

The name of the Amazon EC2 SSH key to be used for connecting to the launched server.

iamInstanceProfileName
  • Type: string

The name of the IAM instance profile.

instanceType
  • Type: string

The instance type to use when launching the server.

logicalId
  • Type: string

The logical ID of the server in the CloudFormation template.

securityGroup
  • Type: string

The ID of the security group that applies to the launched server.

server
  • Type: Server structure

The ID of the server with which the launch configuration is associated.

subnet
  • Type: string

The ID of the subnet the server should be launched into.

userData
  • Type: UserData structure

Location of the user-data script to be executed when launching the server.

vpc
  • Type: string

The ID of the VPC into which the server should be launched.

ServerReplicationConfiguration

Description

Replication configuration of a server.

Members
server
  • Type: Server structure

The ID of the server with which this replication configuration is associated.

serverReplicationParameters
  • Type: ServerReplicationParameters structure

The parameters for replicating the server.

ServerReplicationParameters

Description

The replication parameters for replicating a server.

Members
encrypted
  • Type: boolean

Indicates whether the replication job produces encrypted AMIs.

frequency
  • Type: int

The frequency of creating replication jobs for the server.

kmsKeyId
  • Type: string

The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to the KMS key ID

  • ARN referring to the KMS key alias

If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

licenseType
  • Type: string

The license type for creating a replication job for the server.

numberOfRecentAmisToKeep
  • Type: int

The number of recent AMIs to keep when creating a replication job for this server.

runOnce
  • Type: boolean

Indicates whether to run the replication job one time.

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

The seed time for creating a replication job for the server.

ServerValidationConfiguration

Description

Configuration for validating an instance.

Members
name
  • Type: string

The name of the configuration.

server
  • Type: Server structure

Represents a server.

serverValidationStrategy
  • Type: string

The validation strategy.

userDataValidationParameters
  • Type: UserDataValidationParameters structure

The validation parameters.

validationId
  • Type: string

The ID of the validation.

ServerValidationOutput

Description

Contains output from validating an instance.

Members
server
  • Type: Server structure

Represents a server.

Source

Description

Contains the location of a validation script.

Members
s3Location
  • Type: S3Location structure

Location of an Amazon S3 object.

Tag

Description

Key/value pair that can be assigned to an application.

Members
key
  • Type: string

The tag key.

value
  • Type: string

The tag value.

TemporarilyUnavailableException

Description

The service is temporarily unavailable.

Members

UnauthorizedOperationException

Description

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

Members
message
  • Type: string

UserData

Description

A script that runs on first launch of an Amazon EC2 instance. Used for configuring the server during launch.

Members
s3Location
  • Type: S3Location structure

Amazon S3 location of the user-data script.

UserDataValidationParameters

Description

Contains validation parameters.

Members
scriptType
  • Type: string

The type of validation script.

source
  • Type: Source structure

The location of the validation script.

ValidationOutput

Description

Contains validation output.

Members
appValidationOutput
  • Type: AppValidationOutput structure

The output from validating an application.

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

The latest time that the validation was performed.

name
  • Type: string

The name of the validation.

serverValidationOutput
  • Type: ServerValidationOutput structure

The output from validation an instance.

status
  • Type: string

The status of the validation.

statusMessage
  • Type: string

The status message.

validationId
  • Type: string

The ID of the validation.

VmServer

Description

Represents a VM server.

Members
vmManagerName
  • Type: string

The name of the VM manager.

vmManagerType
  • Type: string

The type of VM management product.

vmName
  • Type: string

The name of the VM.

vmPath
  • Type: string

The VM folder path in the vCenter Server virtual machine inventory tree.

vmServerAddress
  • Type: VmServerAddress structure

The VM server location.

VmServerAddress

Description

Represents a VM server location.

Members
vmId
  • Type: string

The ID of the VM.

vmManagerId
  • Type: string

The ID of the VM manager.

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