AWS SDK for PHP 3.x
  • Namespace
  • Class

Namespaces

  • Aws
    • Acm
      • Exception
    • ACMPCA
      • Exception
    • AlexaForBusiness
      • Exception
    • Api
      • ErrorParser
      • Parser
        • Exception
      • Serializer
    • ApiGateway
      • Exception
    • ApplicationAutoScaling
      • Exception
    • ApplicationDiscoveryService
      • Exception
    • Appstream
      • Exception
    • AppSync
      • Exception
    • Athena
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Batch
      • Exception
    • Budgets
      • Exception
    • Cloud9
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchLogs
      • Exception
    • CodeBuild
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodePipeline
      • Exception
    • CodeStar
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoIdentityProvider
      • Exception
    • CognitoSync
      • Exception
    • Comprehend
      • Exception
    • ConfigService
      • Exception
    • Connect
      • Exception
    • CostandUsageReportService
      • Exception
    • CostExplorer
      • Exception
    • Credentials
    • Crypto
      • Cipher
    • DatabaseMigrationService
      • Exception
    • DataPipeline
      • Exception
    • DAX
      • Exception
    • DeviceFarm
      • Exception
    • DirectConnect
      • Exception
    • DirectoryService
      • Exception
    • DynamoDb
      • Exception
    • DynamoDbStreams
      • Exception
    • Ec2
      • Exception
    • Ecr
      • Exception
    • Ecs
      • Exception
    • Efs
      • Exception
    • ElastiCache
      • Exception
    • ElasticBeanstalk
      • Exception
    • ElasticLoadBalancing
      • Exception
    • ElasticLoadBalancingV2
      • Exception
    • ElasticsearchService
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Exception
    • Endpoint
    • Exception
    • Firehose
      • Exception
    • FMS
      • Exception
    • GameLift
      • Exception
    • Glacier
      • Exception
    • Glue
      • Exception
    • Greengrass
      • Exception
    • GuardDuty
      • Exception
    • Handler
      • GuzzleV5
      • GuzzleV6
    • Health
      • Exception
    • Iam
      • Exception
    • ImportExport
      • Exception
    • Inspector
      • Exception
    • Iot
      • Exception
    • IotDataPlane
      • Exception
    • IoTJobsDataPlane
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • Kms
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexRuntimeService
      • Exception
    • Lightsail
      • Exception
    • MachineLearning
      • Exception
    • MarketplaceCommerceAnalytics
      • Exception
    • MarketplaceEntitlementService
      • Exception
    • MarketplaceMetering
      • Exception
    • MediaConvert
      • Exception
    • MediaLive
      • Exception
    • MediaPackage
      • Exception
    • MediaStore
      • Exception
    • MediaStoreData
      • Exception
    • MigrationHub
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • OpsWorks
      • Exception
    • OpsWorksCM
      • Exception
    • Organizations
      • Exception
    • Pinpoint
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • Rds
      • Exception
    • Redshift
      • Exception
    • Rekognition
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Route53
      • Exception
    • Route53Domains
      • Exception
    • S3
      • Crypto
      • Exception
    • SageMaker
      • Exception
    • SageMakerRuntime
      • Exception
    • SecretsManager
      • Exception
    • ServerlessApplicationRepository
      • Exception
    • ServiceCatalog
      • Exception
    • ServiceDiscovery
      • Exception
    • Ses
      • Exception
    • Sfn
      • Exception
    • Shield
      • Exception
    • Signature
    • Sms
      • Exception
    • SnowBall
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • StorageGateway
      • Exception
    • Sts
      • Exception
    • Support
      • Exception
    • Swf
      • Exception
    • TranscribeService
      • Exception
    • Translate
      • Exception
    • Waf
      • Exception
    • WafRegional
      • Exception
    • WorkDocs
      • Exception
    • WorkMail
      • Exception
    • WorkSpaces
      • Exception
    • XRay
      • Exception
  • GuzzleHttp
    • Promise
    • Psr7
  • Psr
    • Http
      • Message

Classes

  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Api\AbstractModel
  • Aws\Api\ApiProvider
  • Aws\Api\DateTimeResult
  • Aws\Api\DocModel
  • 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\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\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\Appstream\AppstreamClient
  • Aws\AppSync\AppSyncClient
  • Aws\Athena\AthenaClient
  • Aws\AutoScaling\AutoScalingClient
  • Aws\AutoScalingPlans\AutoScalingPlansClient
  • Aws\AwsClient
  • Aws\Batch\BatchClient
  • Aws\Budgets\BudgetsClient
  • Aws\ClientResolver
  • Aws\Cloud9\Cloud9Client
  • Aws\CloudDirectory\CloudDirectoryClient
  • Aws\CloudFormation\CloudFormationClient
  • Aws\CloudFront\CloudFrontClient
  • Aws\CloudFront\CookieSigner
  • Aws\CloudFront\UrlSigner
  • Aws\CloudHsm\CloudHsmClient
  • Aws\CloudHSMV2\CloudHSMV2Client
  • Aws\CloudSearch\CloudSearchClient
  • Aws\CloudSearchDomain\CloudSearchDomainClient
  • Aws\CloudTrail\CloudTrailClient
  • Aws\CloudTrail\LogFileIterator
  • Aws\CloudTrail\LogFileReader
  • Aws\CloudTrail\LogRecordIterator
  • Aws\CloudWatch\CloudWatchClient
  • Aws\CloudWatchEvents\CloudWatchEventsClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CodeBuild\CodeBuildClient
  • Aws\CodeCommit\CodeCommitClient
  • Aws\CodeDeploy\CodeDeployClient
  • Aws\CodePipeline\CodePipelineClient
  • Aws\CodeStar\CodeStarClient
  • Aws\CognitoIdentity\CognitoIdentityClient
  • Aws\CognitoIdentity\CognitoIdentityProvider
  • Aws\CognitoIdentityProvider\CognitoIdentityProviderClient
  • Aws\CognitoSync\CognitoSyncClient
  • Aws\Command
  • Aws\CommandPool
  • Aws\Comprehend\ComprehendClient
  • Aws\ConfigService\ConfigServiceClient
  • Aws\Connect\ConnectClient
  • Aws\CostandUsageReportService\CostandUsageReportServiceClient
  • Aws\CostExplorer\CostExplorerClient
  • Aws\Credentials\AssumeRoleCredentialProvider
  • 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\MaterialsProvider
  • Aws\DatabaseMigrationService\DatabaseMigrationServiceClient
  • Aws\DataPipeline\DataPipelineClient
  • Aws\DAX\DAXClient
  • Aws\DeviceFarm\DeviceFarmClient
  • Aws\DirectConnect\DirectConnectClient
  • Aws\DirectoryService\DirectoryServiceClient
  • Aws\DoctrineCacheAdapter
  • Aws\DynamoDb\BinaryValue
  • Aws\DynamoDb\DynamoDbClient
  • Aws\DynamoDb\LockingSessionConnection
  • Aws\DynamoDb\Marshaler
  • Aws\DynamoDb\NumberValue
  • Aws\DynamoDb\SessionHandler
  • Aws\DynamoDb\SetValue
  • Aws\DynamoDb\StandardSessionConnection
  • Aws\DynamoDb\WriteRequestBatch
  • Aws\DynamoDbStreams\DynamoDbStreamsClient
  • Aws\Ec2\Ec2Client
  • Aws\Ecr\EcrClient
  • Aws\Ecs\EcsClient
  • Aws\Efs\EfsClient
  • Aws\ElastiCache\ElastiCacheClient
  • Aws\ElasticBeanstalk\ElasticBeanstalkClient
  • Aws\ElasticLoadBalancing\ElasticLoadBalancingClient
  • Aws\ElasticLoadBalancingV2\ElasticLoadBalancingV2Client
  • Aws\ElasticsearchService\ElasticsearchServiceClient
  • Aws\ElasticTranscoder\ElasticTranscoderClient
  • Aws\Emr\EmrClient
  • Aws\Endpoint\EndpointProvider
  • Aws\Endpoint\Partition
  • Aws\Endpoint\PartitionEndpointProvider
  • Aws\Endpoint\PatternEndpointProvider
  • Aws\Firehose\FirehoseClient
  • Aws\FMS\FMSClient
  • Aws\GameLift\GameLiftClient
  • Aws\Glacier\GlacierClient
  • Aws\Glacier\MultipartUploader
  • Aws\Glacier\TreeHash
  • Aws\Glue\GlueClient
  • Aws\Greengrass\GreengrassClient
  • 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\History
  • Aws\Iam\IamClient
  • Aws\IdempotencyTokenMiddleware
  • Aws\ImportExport\ImportExportClient
  • Aws\Inspector\InspectorClient
  • Aws\Iot\IotClient
  • Aws\IotDataPlane\IotDataPlaneClient
  • Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
  • Aws\JsonCompiler
  • Aws\Kinesis\KinesisClient
  • Aws\KinesisAnalytics\KinesisAnalyticsClient
  • Aws\KinesisVideo\KinesisVideoClient
  • Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient
  • Aws\KinesisVideoMedia\KinesisVideoMediaClient
  • Aws\Kms\KmsClient
  • Aws\Lambda\LambdaClient
  • Aws\LexModelBuildingService\LexModelBuildingServiceClient
  • Aws\LexRuntimeService\LexRuntimeServiceClient
  • Aws\Lightsail\LightsailClient
  • Aws\LruArrayCache
  • Aws\MachineLearning\MachineLearningClient
  • Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient
  • Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient
  • Aws\MarketplaceMetering\MarketplaceMeteringClient
  • Aws\MediaConvert\MediaConvertClient
  • Aws\MediaLive\MediaLiveClient
  • Aws\MediaPackage\MediaPackageClient
  • Aws\MediaStore\MediaStoreClient
  • Aws\MediaStoreData\MediaStoreDataClient
  • Aws\Middleware
  • Aws\MigrationHub\MigrationHubClient
  • Aws\Mobile\MobileClient
  • Aws\MockHandler
  • Aws\MQ\MQClient
  • Aws\MTurk\MTurkClient
  • Aws\Multipart\UploadState
  • Aws\MultiRegionClient
  • Aws\OpsWorks\OpsWorksClient
  • Aws\OpsWorksCM\OpsWorksCMClient
  • Aws\Organizations\OrganizationsClient
  • Aws\PhpHash
  • Aws\Pinpoint\PinpointClient
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\PsrCacheAdapter
  • Aws\Rds\AuthTokenGenerator
  • Aws\Rds\RdsClient
  • Aws\Redshift\RedshiftClient
  • Aws\Rekognition\RekognitionClient
  • Aws\ResourceGroups\ResourceGroupsClient
  • Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
  • Aws\Result
  • Aws\ResultPaginator
  • Aws\RetryMiddleware
  • Aws\Route53\Route53Client
  • Aws\Route53Domains\Route53DomainsClient
  • Aws\S3\BatchDelete
  • Aws\S3\Crypto\HeadersMetadataStrategy
  • Aws\S3\Crypto\InstructionFileMetadataStrategy
  • Aws\S3\Crypto\S3EncryptionClient
  • Aws\S3\Crypto\S3EncryptionMultipartUploader
  • Aws\S3\GetBucketLocationParser
  • Aws\S3\MultipartUploader
  • Aws\S3\ObjectCopier
  • Aws\S3\ObjectUploader
  • Aws\S3\PostObject
  • Aws\S3\PostObjectV4
  • Aws\S3\S3Client
  • Aws\S3\S3MultiRegionClient
  • Aws\S3\S3UriParser
  • Aws\S3\StreamWrapper
  • Aws\S3\Transfer
  • Aws\SageMaker\SageMakerClient
  • Aws\SageMakerRuntime\SageMakerRuntimeClient
  • Aws\Sdk
  • Aws\SecretsManager\SecretsManagerClient
  • Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient
  • Aws\ServiceCatalog\ServiceCatalogClient
  • Aws\ServiceDiscovery\ServiceDiscoveryClient
  • Aws\Ses\SesClient
  • Aws\Sfn\SfnClient
  • Aws\Shield\ShieldClient
  • Aws\Signature\AnonymousSignature
  • Aws\Signature\S3SignatureV4
  • Aws\Signature\SignatureProvider
  • Aws\Signature\SignatureV4
  • Aws\Sms\SmsClient
  • Aws\SnowBall\SnowBallClient
  • Aws\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • Aws\StorageGateway\StorageGatewayClient
  • Aws\Sts\StsClient
  • Aws\Support\SupportClient
  • Aws\Swf\SwfClient
  • Aws\TraceMiddleware
  • Aws\TranscribeService\TranscribeServiceClient
  • Aws\Translate\TranslateClient
  • Aws\Waf\WafClient
  • Aws\WafRegional\WafRegionalClient
  • Aws\Waiter
  • Aws\WorkDocs\WorkDocsClient
  • Aws\WorkMail\WorkMailClient
  • Aws\WorkSpaces\WorkSpacesClient
  • Aws\WrappedHttpHandler
  • Aws\XRay\XRayClient

Interfaces

  • Aws\AwsClientInterface
  • Aws\CacheInterface
  • Aws\CommandInterface
  • Aws\Credentials\CredentialsInterface
  • Aws\Crypto\AesStreamInterface
  • Aws\Crypto\Cipher\CipherMethod
  • Aws\Crypto\MetadataStrategyInterface
  • Aws\DynamoDb\SessionConnectionInterface
  • Aws\Endpoint\PartitionInterface
  • Aws\HashInterface
  • Aws\ResultInterface
  • Aws\S3\S3ClientInterface
  • Aws\Signature\SignatureInterface

Traits

  • Aws\Api\ErrorParser\JsonParserTrait
  • Aws\Api\Parser\PayloadParserTrait
  • Aws\AwsClientTrait
  • Aws\Crypto\Cipher\CipherBuilderTrait
  • Aws\Crypto\DecryptionTrait
  • Aws\Crypto\EncryptionTrait
  • Aws\HasDataTrait
  • Aws\S3\Crypto\CryptoParamsTrait
  • Aws\S3\MultipartUploadingTrait
  • Aws\S3\S3ClientTrait
  • Aws\Signature\SignatureTrait

Exceptions

  • Aws\Acm\Exception\AcmException
  • Aws\ACMPCA\Exception\ACMPCAException
  • Aws\AlexaForBusiness\Exception\AlexaForBusinessException
  • Aws\Api\Parser\Exception\ParserException
  • Aws\ApiGateway\Exception\ApiGatewayException
  • Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException
  • Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException
  • Aws\Appstream\Exception\AppstreamException
  • Aws\AppSync\Exception\AppSyncException
  • Aws\Athena\Exception\AthenaException
  • Aws\AutoScaling\Exception\AutoScalingException
  • Aws\AutoScalingPlans\Exception\AutoScalingPlansException
  • Aws\Batch\Exception\BatchException
  • Aws\Budgets\Exception\BudgetsException
  • Aws\Cloud9\Exception\Cloud9Exception
  • Aws\CloudDirectory\Exception\CloudDirectoryException
  • Aws\CloudFormation\Exception\CloudFormationException
  • Aws\CloudFront\Exception\CloudFrontException
  • Aws\CloudHsm\Exception\CloudHsmException
  • Aws\CloudHSMV2\Exception\CloudHSMV2Exception
  • Aws\CloudSearch\Exception\CloudSearchException
  • Aws\CloudSearchDomain\Exception\CloudSearchDomainException
  • Aws\CloudTrail\Exception\CloudTrailException
  • Aws\CloudWatch\Exception\CloudWatchException
  • Aws\CloudWatchEvents\Exception\CloudWatchEventsException
  • Aws\CloudWatchLogs\Exception\CloudWatchLogsException
  • Aws\CodeBuild\Exception\CodeBuildException
  • Aws\CodeCommit\Exception\CodeCommitException
  • Aws\CodeDeploy\Exception\CodeDeployException
  • Aws\CodePipeline\Exception\CodePipelineException
  • Aws\CodeStar\Exception\CodeStarException
  • Aws\CognitoIdentity\Exception\CognitoIdentityException
  • Aws\CognitoIdentityProvider\Exception\CognitoIdentityProviderException
  • Aws\CognitoSync\Exception\CognitoSyncException
  • Aws\Comprehend\Exception\ComprehendException
  • Aws\ConfigService\Exception\ConfigServiceException
  • Aws\Connect\Exception\ConnectException
  • Aws\CostandUsageReportService\Exception\CostandUsageReportServiceException
  • Aws\CostExplorer\Exception\CostExplorerException
  • Aws\DatabaseMigrationService\Exception\DatabaseMigrationServiceException
  • Aws\DataPipeline\Exception\DataPipelineException
  • Aws\DAX\Exception\DAXException
  • Aws\DeviceFarm\Exception\DeviceFarmException
  • Aws\DirectConnect\Exception\DirectConnectException
  • Aws\DirectoryService\Exception\DirectoryServiceException
  • Aws\DynamoDb\Exception\DynamoDbException
  • Aws\DynamoDbStreams\Exception\DynamoDbStreamsException
  • Aws\Ec2\Exception\Ec2Exception
  • Aws\Ecr\Exception\EcrException
  • Aws\Ecs\Exception\EcsException
  • Aws\Efs\Exception\EfsException
  • Aws\ElastiCache\Exception\ElastiCacheException
  • Aws\ElasticBeanstalk\Exception\ElasticBeanstalkException
  • Aws\ElasticLoadBalancing\Exception\ElasticLoadBalancingException
  • Aws\ElasticLoadBalancingV2\Exception\ElasticLoadBalancingV2Exception
  • Aws\ElasticsearchService\Exception\ElasticsearchServiceException
  • Aws\ElasticTranscoder\Exception\ElasticTranscoderException
  • Aws\Emr\Exception\EmrException
  • Aws\Exception\AwsException
  • Aws\Exception\CouldNotCreateChecksumException
  • Aws\Exception\CredentialsException
  • Aws\Exception\MultipartUploadException
  • Aws\Exception\UnresolvedApiException
  • Aws\Exception\UnresolvedEndpointException
  • Aws\Exception\UnresolvedSignatureException
  • Aws\Firehose\Exception\FirehoseException
  • Aws\FMS\Exception\FMSException
  • Aws\GameLift\Exception\GameLiftException
  • Aws\Glacier\Exception\GlacierException
  • Aws\Glue\Exception\GlueException
  • Aws\Greengrass\Exception\GreengrassException
  • Aws\GuardDuty\Exception\GuardDutyException
  • Aws\Health\Exception\HealthException
  • Aws\Iam\Exception\IamException
  • Aws\ImportExport\Exception\ImportExportException
  • Aws\Inspector\Exception\InspectorException
  • Aws\Iot\Exception\IotException
  • Aws\IotDataPlane\Exception\IotDataPlaneException
  • Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException
  • Aws\Kinesis\Exception\KinesisException
  • Aws\KinesisAnalytics\Exception\KinesisAnalyticsException
  • Aws\KinesisVideo\Exception\KinesisVideoException
  • Aws\KinesisVideoArchivedMedia\Exception\KinesisVideoArchivedMediaException
  • Aws\KinesisVideoMedia\Exception\KinesisVideoMediaException
  • Aws\Kms\Exception\KmsException
  • Aws\Lambda\Exception\LambdaException
  • Aws\LexModelBuildingService\Exception\LexModelBuildingServiceException
  • Aws\LexRuntimeService\Exception\LexRuntimeServiceException
  • Aws\Lightsail\Exception\LightsailException
  • Aws\MachineLearning\Exception\MachineLearningException
  • Aws\MarketplaceCommerceAnalytics\Exception\MarketplaceCommerceAnalyticsException
  • Aws\MarketplaceEntitlementService\Exception\MarketplaceEntitlementServiceException
  • Aws\MarketplaceMetering\Exception\MarketplaceMeteringException
  • Aws\MediaConvert\Exception\MediaConvertException
  • Aws\MediaLive\Exception\MediaLiveException
  • Aws\MediaPackage\Exception\MediaPackageException
  • Aws\MediaStore\Exception\MediaStoreException
  • Aws\MediaStoreData\Exception\MediaStoreDataException
  • Aws\MigrationHub\Exception\MigrationHubException
  • Aws\Mobile\Exception\MobileException
  • Aws\MQ\Exception\MQException
  • Aws\MTurk\Exception\MTurkException
  • Aws\OpsWorks\Exception\OpsWorksException
  • Aws\OpsWorksCM\Exception\OpsWorksCMException
  • Aws\Organizations\Exception\OrganizationsException
  • Aws\Pinpoint\Exception\PinpointException
  • Aws\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • Aws\Rds\Exception\RdsException
  • Aws\Redshift\Exception\RedshiftException
  • Aws\Rekognition\Exception\RekognitionException
  • Aws\ResourceGroups\Exception\ResourceGroupsException
  • Aws\ResourceGroupsTaggingAPI\Exception\ResourceGroupsTaggingAPIException
  • Aws\Route53\Exception\Route53Exception
  • Aws\Route53Domains\Exception\Route53DomainsException
  • Aws\S3\Exception\DeleteMultipleObjectsException
  • Aws\S3\Exception\PermanentRedirectException
  • Aws\S3\Exception\S3Exception
  • Aws\S3\Exception\S3MultipartUploadException
  • Aws\SageMaker\Exception\SageMakerException
  • Aws\SageMakerRuntime\Exception\SageMakerRuntimeException
  • Aws\SecretsManager\Exception\SecretsManagerException
  • Aws\ServerlessApplicationRepository\Exception\ServerlessApplicationRepositoryException
  • Aws\ServiceCatalog\Exception\ServiceCatalogException
  • Aws\ServiceDiscovery\Exception\ServiceDiscoveryException
  • Aws\Ses\Exception\SesException
  • Aws\Sfn\Exception\SfnException
  • Aws\Shield\Exception\ShieldException
  • Aws\Sms\Exception\SmsException
  • Aws\SnowBall\Exception\SnowBallException
  • Aws\Sns\Exception\InvalidSnsMessageException
  • Aws\Sns\Exception\SnsException
  • Aws\Sqs\Exception\SqsException
  • Aws\Ssm\Exception\SsmException
  • Aws\StorageGateway\Exception\StorageGatewayException
  • Aws\Sts\Exception\StsException
  • Aws\Support\Exception\SupportException
  • Aws\Swf\Exception\SwfException
  • Aws\TranscribeService\Exception\TranscribeServiceException
  • Aws\Translate\Exception\TranslateException
  • Aws\Waf\Exception\WafException
  • Aws\WafRegional\Exception\WafRegionalException
  • Aws\WorkDocs\Exception\WorkDocsException
  • Aws\WorkMail\Exception\WorkMailException
  • Aws\WorkSpaces\Exception\WorkSpacesException
  • Aws\XRay\Exception\XRayException

Functions

  • Aws\clear_compiled_json
  • Aws\constantly
  • Aws\default_http_handler
  • Aws\describe_type
  • Aws\dir_iterator
  • Aws\filter
  • Aws\flatmap
  • Aws\load_compiled_json
  • Aws\manifest
  • Aws\map
  • Aws\or_chain
  • Aws\partition
  • Aws\recursive_dir_iterator
  • Aws\serialize

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 */).

  • CreateReplicationJob ( array $params = [] )

    The CreateReplicationJob API is used to create a ReplicationJob to replicate a server on AWS.

  • DeleteReplicationJob ( array $params = [] )

    The DeleteReplicationJob API is used to delete a ReplicationJob, resulting in no further ReplicationRuns.

  • DeleteServerCatalog ( array $params = [] )

    The DeleteServerCatalog API clears all servers from your server catalog.

  • DisassociateConnector ( array $params = [] )

    The DisassociateConnector API will disassociate a connector from the Server Migration Service, rendering it unavailable to support replication jobs.

  • GetConnectors ( array $params = [] )

    The GetConnectors API returns a list of connectors that are registered with the Server Migration Service.

  • GetReplicationJobs ( array $params = [] )

    The GetReplicationJobs API will return all of your ReplicationJobs and their details.

  • GetReplicationRuns ( array $params = [] )

    The GetReplicationRuns API will return all ReplicationRuns for a given ReplicationJob.

  • GetServers ( array $params = [] )

    The GetServers API returns a list of all servers in your server catalog.

  • ImportServerCatalog ( array $params = [] )

    The ImportServerCatalog API is used to gather the complete list of on-premises servers on your premises.

  • StartOnDemandReplicationRun ( array $params = [] )

    The StartOnDemandReplicationRun API is used to start a ReplicationRun on demand (in addition to those that are scheduled based on your frequency).

  • UpdateReplicationJob ( array $params = [] )

    The UpdateReplicationJob API is used to change the settings of your existing ReplicationJob created using CreateReplicationJob.

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:

  • GetReplicationJobs
  • GetReplicationRuns
  • GetConnectors
  • GetServers

Operations

CreateReplicationJob

$result = $client->createReplicationJob([/* ... */]);
$promise = $client->createReplicationJobAsync([/* ... */]);
The CreateReplicationJob API is used to create a ReplicationJob to replicate a server on AWS. Call this API to first create a ReplicationJob, which will then schedule periodic ReplicationRuns to replicate your server to AWS. Each ReplicationRun will result in the creation of an AWS AMI.

Parameter Syntax

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

Parameter Details

Members
description
  • Type: string
The description for a Replication Job/Run.
frequency
  • Type: int
Interval between Replication Runs. This value is specified in hours, and represents the time between consecutive Replication Runs.
licenseType
  • Type: string
The license type to be used for the Amazon Machine Image (AMI) created after a successful ReplicationRun.
roleName
  • Type: string
Name of service role in customer's account to be used by SMS service.
seedReplicationTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp of an operation
serverId
  • Type: string
Unique Identifier for a server

Result Syntax

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

Result Details

Members
replicationJobId
  • Type: string
The unique identifier for a Replication Job.

Errors

  • InvalidParameterException: A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • MissingRequiredParameterException: The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • UnauthorizedOperationException: This user does not have permissions to perform this operation.

  • OperationNotPermittedException: The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

  • ServerCannotBeReplicatedException: The provided server cannot be replicated.

  • ReplicationJobAlreadyExistsException: An active Replication Job already exists for the specified server.

  • NoConnectorsAvailableException: No connectors are available to handle this request. Please associate connector(s) and verify any existing connectors are healthy and can respond to requests.

  • InternalError: An internal error has occured.

DeleteReplicationJob

$result = $client->deleteReplicationJob([/* ... */]);
$promise = $client->deleteReplicationJobAsync([/* ... */]);
The DeleteReplicationJob API is used to delete a ReplicationJob, resulting in no further ReplicationRuns. This will delete the contents of the S3 bucket used to store SMS artifacts, but will not delete any AMIs created by the SMS service.

Parameter Syntax

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

Parameter Details

Members
replicationJobId
  • Type: string
The unique identifier for a Replication Job.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidParameterException: A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • MissingRequiredParameterException: The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • UnauthorizedOperationException: This user does not have permissions to perform this operation.

  • OperationNotPermittedException: The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

  • ReplicationJobNotFoundException: The specified Replication Job cannot be found.

DeleteServerCatalog

$result = $client->deleteServerCatalog([/* ... */]);
$promise = $client->deleteServerCatalogAsync([/* ... */]);
The DeleteServerCatalog API clears all servers from your server catalog. This means that these servers will no longer be accessible to the Server Migration Service.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException: This user does not have permissions to perform this operation.

  • OperationNotPermittedException: The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

  • InvalidParameterException: A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • MissingRequiredParameterException: The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

DisassociateConnector

$result = $client->disassociateConnector([/* ... */]);
$promise = $client->disassociateConnectorAsync([/* ... */]);
The DisassociateConnector API will disassociate a connector from the Server Migration Service, rendering it unavailable to support replication jobs.

Parameter Syntax

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

Parameter Details

Members
connectorId
  • Type: string
Unique Identifier for Connector

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • MissingRequiredParameterException: The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • UnauthorizedOperationException: This user does not have permissions to perform this operation.

  • OperationNotPermittedException: The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

  • InvalidParameterException: A parameter specified in the request is not valid, is unsupported, or cannot be used.

GetConnectors

$result = $client->getConnectors([/* ... */]);
$promise = $client->getConnectorsAsync([/* ... */]);
The GetConnectors API returns a list of connectors that are 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 one API call. If left empty, this will default to 50.
nextToken
  • Type: string
Pagination token to pass as input to API call

Result Syntax

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

Result Details

Members
connectorList
  • Type: Array of Connector structures
List of connectors
nextToken
  • Type: string
Pagination token to pass as input to API call

Errors

  • UnauthorizedOperationException: This user does not have permissions to perform this operation.

GetReplicationJobs

$result = $client->getReplicationJobs([/* ... */]);
$promise = $client->getReplicationJobsAsync([/* ... */]);
The GetReplicationJobs API will return all of your ReplicationJobs and their details. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationJobs.

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 one API call. If left empty, this will default to 50.
nextToken
  • Type: string
Pagination token to pass as input to API call
replicationJobId
  • Type: string
The unique identifier for a Replication Job.

Result Syntax

[
    'nextToken' => '<string>',
    'replicationJobList' => [
        [
            'description' => '<string>',
            'frequency' => <integer>,
            'latestAmiId' => '<string>',
            'licenseType' => 'AWS|BYOL',
            'nextReplicationRunStartTime' => <DateTime>,
            'replicationJobId' => '<string>',
            'replicationRunList' => [
                [
                    'amiId' => '<string>',
                    'completedTime' => <DateTime>,
                    'description' => '<string>',
                    'replicationRunId' => '<string>',
                    'scheduledStartTime' => <DateTime>,
                    'state' => 'PENDING|MISSED|ACTIVE|FAILED|COMPLETED|DELETING|DELETED',
                    'statusMessage' => '<string>',
                    'type' => 'ON_DEMAND|AUTOMATIC',
                ],
                // ...
            ],
            'roleName' => '<string>',
            'seedReplicationTime' => <DateTime>,
            'serverId' => '<string>',
            'serverType' => 'VIRTUAL_MACHINE',
            'state' => 'PENDING|ACTIVE|FAILED|DELETING|DELETED',
            'statusMessage' => '<string>',
            'vmServer' => [
                'vmManagerName' => '<string>',
                'vmManagerType' => 'VSPHERE',
                'vmName' => '<string>',
                'vmPath' => '<string>',
                'vmServerAddress' => [
                    'vmId' => '<string>',
                    'vmManagerId' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string
Pagination token to pass as input to API call
replicationJobList
  • Type: Array of ReplicationJob structures
List of Replication Jobs

Errors

  • InvalidParameterException: A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • MissingRequiredParameterException: The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • UnauthorizedOperationException: This user does not have permissions to perform this operation.

GetReplicationRuns

$result = $client->getReplicationRuns([/* ... */]);
$promise = $client->getReplicationRunsAsync([/* ... */]);
The GetReplicationRuns API will return all ReplicationRuns for a given ReplicationJob. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationRuns for a ReplicationJob.

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 one API call. If left empty, this will default to 50.
nextToken
  • Type: string
Pagination token to pass as input to API call
replicationJobId
  • Type: string
The unique identifier for a Replication Job.

Result Syntax

[
    'nextToken' => '<string>',
    'replicationJob' => [
        'description' => '<string>',
        'frequency' => <integer>,
        'latestAmiId' => '<string>',
        'licenseType' => 'AWS|BYOL',
        'nextReplicationRunStartTime' => <DateTime>,
        'replicationJobId' => '<string>',
        'replicationRunList' => [
            [
                'amiId' => '<string>',
                'completedTime' => <DateTime>,
                'description' => '<string>',
                'replicationRunId' => '<string>',
                'scheduledStartTime' => <DateTime>,
                'state' => 'PENDING|MISSED|ACTIVE|FAILED|COMPLETED|DELETING|DELETED',
                'statusMessage' => '<string>',
                'type' => 'ON_DEMAND|AUTOMATIC',
            ],
            // ...
        ],
        'roleName' => '<string>',
        'seedReplicationTime' => <DateTime>,
        'serverId' => '<string>',
        'serverType' => 'VIRTUAL_MACHINE',
        'state' => 'PENDING|ACTIVE|FAILED|DELETING|DELETED',
        'statusMessage' => '<string>',
        'vmServer' => [
            'vmManagerName' => '<string>',
            'vmManagerType' => 'VSPHERE',
            'vmName' => '<string>',
            'vmPath' => '<string>',
            'vmServerAddress' => [
                'vmId' => '<string>',
                'vmManagerId' => '<string>',
            ],
        ],
    ],
    'replicationRunList' => [
        [
            'amiId' => '<string>',
            'completedTime' => <DateTime>,
            'description' => '<string>',
            'replicationRunId' => '<string>',
            'scheduledStartTime' => <DateTime>,
            'state' => 'PENDING|MISSED|ACTIVE|FAILED|COMPLETED|DELETING|DELETED',
            'statusMessage' => '<string>',
            'type' => 'ON_DEMAND|AUTOMATIC',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string
Pagination token to pass as input to API call
replicationJob
  • Type: ReplicationJob structure
Object representing a Replication Job
replicationRunList
  • Type: Array of ReplicationRun structures
List of Replication Runs

Errors

  • InvalidParameterException: A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • MissingRequiredParameterException: The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • UnauthorizedOperationException: This user does not have permissions to perform this operation.

GetServers

$result = $client->getServers([/* ... */]);
$promise = $client->getServersAsync([/* ... */]);
The GetServers API returns a list of all servers in your server catalog. For this call to succeed, you must previously have called ImportServerCatalog.

Parameter Syntax

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

Parameter Details

Members
maxResults
  • Type: int
The maximum number of results to return in one API call. If left empty, this will default to 50.
nextToken
  • Type: string
Pagination token to pass as input to API call

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',
                'vmName' => '<string>',
                'vmPath' => '<string>',
                'vmServerAddress' => [
                    'vmId' => '<string>',
                    'vmManagerId' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Members
lastModifiedOn
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp of an operation
nextToken
  • Type: string
Pagination token to pass as input to API call
serverCatalogStatus
  • Type: string
Status of Server catalog
serverList
  • Type: Array of Server structures
List of servers from catalog

Errors

  • UnauthorizedOperationException: This user does not have permissions to perform this operation.

ImportServerCatalog

$result = $client->importServerCatalog([/* ... */]);
$promise = $client->importServerCatalogAsync([/* ... */]);
The ImportServerCatalog API is used to gather the complete list of on-premises servers on your premises. This API call requires connectors to be installed and monitoring all servers you would like imported. This API call returns immediately, but may take some time to retrieve all of the servers.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • UnauthorizedOperationException: This user does not have permissions to perform this operation.

  • OperationNotPermittedException: The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

  • InvalidParameterException: A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • MissingRequiredParameterException: The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • NoConnectorsAvailableException: No connectors are available to handle this request. Please associate connector(s) and verify any existing connectors are healthy and can respond to requests.

StartOnDemandReplicationRun

$result = $client->startOnDemandReplicationRun([/* ... */]);
$promise = $client->startOnDemandReplicationRunAsync([/* ... */]);
The StartOnDemandReplicationRun API is used to start a ReplicationRun on demand (in addition to those that are scheduled based on your frequency). This ReplicationRun will start immediately. StartOnDemandReplicationRun is subject to limits on how many on demand ReplicationRuns you may call per 24-hour period.

Parameter Syntax

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

Parameter Details

Members
description
  • Type: string
The description for a Replication Job/Run.
replicationJobId
  • Type: string
The unique identifier for a Replication Job.

Result Syntax

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

Result Details

Members
replicationRunId
  • Type: string
The unique identifier for a Replication Run.

Errors

  • InvalidParameterException: A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • MissingRequiredParameterException: The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • UnauthorizedOperationException: This user does not have permissions to perform this operation.

  • OperationNotPermittedException: The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

  • ReplicationRunLimitExceededException: This user has exceeded the maximum allowed Replication Run limit.

UpdateReplicationJob

$result = $client->updateReplicationJob([/* ... */]);
$promise = $client->updateReplicationJobAsync([/* ... */]);
The UpdateReplicationJob API is used to change the settings of your existing ReplicationJob created using CreateReplicationJob. Calling this API will affect the next scheduled ReplicationRun.

Parameter Syntax

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

Parameter Details

Members
description
  • Type: string
The description for a Replication Job/Run.
frequency
  • Type: int
Interval between Replication Runs. This value is specified in hours, and represents the time between consecutive Replication Runs.
licenseType
  • Type: string
The license type to be used for the Amazon Machine Image (AMI) created after a successful ReplicationRun.
nextReplicationRunStartTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp of an operation
replicationJobId
  • Type: string
The unique identifier for a Replication Job.
roleName
  • Type: string
Name of service role in customer's account to be used by SMS service.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidParameterException: A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • MissingRequiredParameterException: The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • OperationNotPermittedException: The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

  • UnauthorizedOperationException: This user does not have permissions to perform this operation.

  • ServerCannotBeReplicatedException: The provided server cannot be replicated.

  • ReplicationJobNotFoundException: The specified Replication Job cannot be found.

  • InternalError: An internal error has occured.

Shapes

Connector

Description
Object representing a Connector
Members
associatedOn
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp of an operation
capabilityList
  • Type: Array of strings
List of Connector Capabilities
connectorId
  • Type: string
Unique Identifier for Connector
ipAddress
  • Type: string
Internet Protocol (IP) Address
macAddress
  • Type: string
Hardware (MAC) address
status
  • Type: string
Status of on-premise Connector
version
  • Type: string
Connector version string
vmManagerId
  • Type: string
Unique Identifier for VM Manager
vmManagerName
  • Type: string
VM Manager Name
vmManagerType
  • Type: string
VM Management Product

InternalError

Description
An internal error has occured.
Members
message
  • Type: string
Error Message string

InvalidParameterException

Description
A parameter specified in the request is not valid, is unsupported, or cannot be used.
Members
message
  • Type: string
Error Message string

MissingRequiredParameterException

Description
The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.
Members
message
  • Type: string
Error Message string

NoConnectorsAvailableException

Description
No connectors are available to handle this request. Please associate connector(s) and verify any existing connectors are healthy and can respond to requests.
Members
message
  • Type: string
Error Message string

OperationNotPermittedException

Description
The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.
Members
message
  • Type: string
Error Message string

ReplicationJob

Description
Object representing a Replication Job
Members
description
  • Type: string
The description for a Replication Job/Run.
frequency
  • Type: int
Interval between Replication Runs. This value is specified in hours, and represents the time between consecutive Replication Runs.
latestAmiId
  • Type: string
The AMI id for the image resulting from a Replication Run.
licenseType
  • Type: string
The license type to be used for the Amazon Machine Image (AMI) created after a successful ReplicationRun.
nextReplicationRunStartTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp of an operation
replicationJobId
  • Type: string
The unique identifier for a Replication Job.
replicationRunList
  • Type: Array of ReplicationRun structures
List of Replication Runs
roleName
  • Type: string
Name of service role in customer's account to be used by SMS service.
seedReplicationTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp of an operation
serverId
  • Type: string
Unique Identifier for a server
serverType
  • Type: string
Type of server.
state
  • Type: string
Current state of Replication Job
statusMessage
  • Type: string
String describing current status of Replication Job
vmServer
  • Type: VmServer structure
Object representing a VM server

ReplicationJobAlreadyExistsException

Description
An active Replication Job already exists for the specified server.
Members
message
  • Type: string
Error Message string

ReplicationJobNotFoundException

Description
The specified Replication Job cannot be found.
Members
message
  • Type: string
Error Message string

ReplicationRun

Description
Object representing a Replication Run
Members
amiId
  • Type: string
The AMI id for the image resulting from a Replication Run.
completedTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp of an operation
description
  • Type: string
The description for a Replication Job/Run.
replicationRunId
  • Type: string
The unique identifier for a Replication Run.
scheduledStartTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp of an operation
state
  • Type: string
Current state of Replication Run
statusMessage
  • Type: string
String describing current status of Replication Run
type
  • Type: string
Type of Replication Run

ReplicationRunLimitExceededException

Description
This user has exceeded the maximum allowed Replication Run limit.
Members
message
  • Type: string
Error Message string

Server

Description
Object representing a server
Members
replicationJobId
  • Type: string
The unique identifier for a Replication Job.
replicationJobTerminated
  • Type: boolean
An indicator of the Replication Job being deleted or failed.
serverId
  • Type: string
Unique Identifier for a server
serverType
  • Type: string
Type of server.
vmServer
  • Type: VmServer structure
Object representing a VM server

ServerCannotBeReplicatedException

Description
The provided server cannot be replicated.
Members
message
  • Type: string
Error Message string

UnauthorizedOperationException

Description
This user does not have permissions to perform this operation.
Members
message
  • Type: string
Error Message string

VmServer

Description
Object representing a VM server
Members
vmManagerName
  • Type: string
VM Manager Name
vmManagerType
  • Type: string
VM Management Product
vmName
  • Type: string
Name of Virtual Machine
vmPath
  • Type: string
Path to VM
vmServerAddress
  • Type: VmServerAddress structure
Object representing a server's location

VmServerAddress

Description
Object representing a server's location
Members
vmId
  • Type: string
Unique Identifier for a VM
vmManagerId
  • Type: string
Unique Identifier for VM Manager
AWS SDK for PHP 3.x API documentation generated by ApiGen