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
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • BackupGateway
      • Exception
    • Batch
      • Exception
    • BillingConductor
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ChimeSDKIdentity
      • Exception
    • ChimeSDKMediaPipelines
      • Exception
    • ChimeSDKMeetings
      • Exception
    • ChimeSDKMessaging
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudControlApi
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchEvidently
      • Exception
    • CloudWatchLogs
      • Exception
    • CloudWatchRUM
      • Exception
    • CodeArtifact
      • Exception
    • CodeBuild
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodeGuruProfiler
      • Exception
    • CodeGuruReviewer
      • Exception
    • CodePipeline
      • Exception
    • CodeStar
      • Exception
    • CodeStarconnections
      • Exception
    • CodeStarNotifications
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoIdentityProvider
      • Exception
    • CognitoSync
      • Exception
    • Comprehend
      • Exception
    • ComprehendMedical
      • Exception
    • ComputeOptimizer
      • Exception
    • ConfigService
      • Exception
    • Connect
      • Exception
    • ConnectCampaignService
      • Exception
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • ConnectWisdomService
      • 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
    • 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
    • EventBridge
      • Exception
    • Exception
    • finspace
      • Exception
    • FinSpaceData
      • Exception
    • Firehose
      • Exception
    • FIS
      • Exception
    • FMS
      • Exception
    • ForecastQueryService
      • Exception
    • ForecastService
      • Exception
    • FraudDetector
      • Exception
    • FSx
      • Exception
    • GameLift
      • Exception
    • GameSparks
      • Exception
    • Glacier
      • Exception
    • GlobalAccelerator
      • Exception
    • Glue
      • Exception
    • GlueDataBrew
      • Exception
    • Greengrass
      • Exception
    • GreengrassV2
      • Exception
    • GroundStation
      • Exception
    • GuardDuty
      • Exception
    • Handler
      • GuzzleV5
      • GuzzleV6
    • Health
      • Exception
    • HealthLake
      • Exception
    • Honeycode
      • Exception
    • Iam
      • Exception
    • IdentityStore
      • Exception
    • imagebuilder
      • Exception
    • ImportExport
      • Exception
    • Inspector
      • Exception
    • Inspector2
      • Exception
    • Iot
      • Exception
    • IoT1ClickDevicesService
      • Exception
    • IoT1ClickProjects
      • Exception
    • IoTAnalytics
      • Exception
    • IotDataPlane
      • Exception
    • IoTDeviceAdvisor
      • Exception
    • IoTEvents
      • Exception
    • IoTEventsData
      • Exception
    • IoTFleetHub
      • Exception
    • IoTJobsDataPlane
      • Exception
    • IoTSecureTunneling
      • Exception
    • IoTSiteWise
      • Exception
    • IoTThingsGraph
      • Exception
    • IoTTwinMaker
      • Exception
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • ivschat
      • Exception
    • Kafka
      • Exception
    • KafkaConnect
      • Exception
    • kendra
      • Exception
    • Keyspaces
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisAnalyticsV2
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • KinesisVideoSignalingChannels
      • Exception
    • Kms
      • Exception
    • LakeFormation
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexModelsV2
      • Exception
    • LexRuntimeService
      • Exception
    • LexRuntimeV2
      • Exception
    • LicenseManager
      • Exception
    • Lightsail
      • Exception
    • LocationService
      • Exception
    • 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
    • MigrationHubRefactorSpaces
      • Exception
    • MigrationHubStrategyRecommendations
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • NimbleStudio
      • 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
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrometheusService
      • Exception
    • Proton
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • RecycleBin
      • Exception
    • Redshift
      • Exception
    • RedshiftDataAPIService
      • Exception
    • Rekognition
      • Exception
    • ResilienceHub
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Retry
      • Exception
    • RoboMaker
      • 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
    • SageMakerRuntime
      • Exception
    • SavingsPlans
      • Exception
    • Schemas
      • Exception
    • SecretsManager
      • Exception
    • SecurityHub
      • Exception
    • ServerlessApplicationRepository
      • Exception
    • ServiceCatalog
      • Exception
    • ServiceDiscovery
      • Exception
    • ServiceQuotas
      • Exception
    • Ses
      • Exception
    • SesV2
      • Exception
    • Sfn
      • Exception
    • Shield
      • Exception
    • Signature
    • signer
      • Exception
    • Sms
      • Exception
    • SnowBall
      • Exception
    • SnowDeviceManagement
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSMContacts
      • Exception
    • SSMIncidents
      • Exception
    • SSO
      • Exception
    • SSOAdmin
      • Exception
    • SSOOIDC
      • Exception
    • StorageGateway
      • Exception
    • Sts
      • Exception
      • RegionalEndpoints
        • Exception
    • Support
      • Exception
    • Swf
      • Exception
    • Synthetics
      • Exception
    • Textract
      • Exception
    • TimestreamQuery
      • Exception
    • TimestreamWrite
      • Exception
    • TranscribeService
      • Exception
    • Transfer
      • Exception
    • Translate
      • Exception
    • VoiceID
      • Exception
    • Waf
      • Exception
    • WafRegional
      • Exception
    • WAFV2
      • Exception
    • WellArchitected
      • Exception
    • WorkDocs
      • Exception
    • WorkLink
      • Exception
    • WorkMail
      • Exception
    • WorkMailMessageFlow
      • Exception
    • WorkSpaces
      • Exception
    • WorkSpacesWeb
      • Exception
    • XRay
      • Exception
  • GuzzleHttp
    • Promise
    • Psr7
  • Psr
    • Http
      • Message

Classes

  • Aws\AbstractConfigurationProvider
  • Aws\AccessAnalyzer\AccessAnalyzerClient
  • Aws\Account\AccountClient
  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Amplify\AmplifyClient
  • Aws\AmplifyBackend\AmplifyBackendClient
  • Aws\AmplifyUIBuilder\AmplifyUIBuilderClient
  • Aws\Api\AbstractModel
  • Aws\Api\ApiProvider
  • Aws\Api\DateTimeResult
  • Aws\Api\DocModel
  • Aws\Api\ErrorParser\AbstractErrorParser
  • Aws\Api\ErrorParser\JsonRpcErrorParser
  • Aws\Api\ErrorParser\RestJsonErrorParser
  • Aws\Api\ErrorParser\XmlErrorParser
  • Aws\Api\ListShape
  • Aws\Api\MapShape
  • Aws\Api\Operation
  • Aws\Api\Parser\Crc32ValidatingParser
  • Aws\Api\Parser\DecodingEventStreamIterator
  • Aws\Api\Parser\EventParsingIterator
  • Aws\Api\Parser\JsonParser
  • Aws\Api\Parser\JsonRpcParser
  • Aws\Api\Parser\QueryParser
  • Aws\Api\Parser\RestJsonParser
  • Aws\Api\Parser\RestXmlParser
  • Aws\Api\Parser\XmlParser
  • Aws\Api\Serializer\XmlBody
  • Aws\Api\Service
  • Aws\Api\Shape
  • Aws\Api\ShapeMap
  • Aws\Api\StructureShape
  • Aws\Api\TimestampShape
  • Aws\Api\Validator
  • Aws\ApiGateway\ApiGatewayClient
  • Aws\ApiGatewayManagementApi\ApiGatewayManagementApiClient
  • Aws\ApiGatewayV2\ApiGatewayV2Client
  • Aws\AppConfig\AppConfigClient
  • Aws\AppConfigData\AppConfigDataClient
  • Aws\Appflow\AppflowClient
  • Aws\AppIntegrationsService\AppIntegrationsServiceClient
  • Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationCostProfiler\ApplicationCostProfilerClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\ApplicationInsights\ApplicationInsightsClient
  • Aws\AppMesh\AppMeshClient
  • Aws\AppRegistry\AppRegistryClient
  • Aws\AppRunner\AppRunnerClient
  • Aws\Appstream\AppstreamClient
  • Aws\AppSync\AppSyncClient
  • Aws\Athena\AthenaClient
  • Aws\AuditManager\AuditManagerClient
  • Aws\AugmentedAIRuntime\AugmentedAIRuntimeClient
  • Aws\AutoScaling\AutoScalingClient
  • Aws\AutoScalingPlans\AutoScalingPlansClient
  • Aws\AwsClient
  • Aws\Backup\BackupClient
  • Aws\BackupGateway\BackupGatewayClient
  • 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\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\CloudWatch\CloudWatchClient
  • Aws\CloudWatchEvents\CloudWatchEventsClient
  • Aws\CloudWatchEvidently\CloudWatchEvidentlyClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CloudWatchRUM\CloudWatchRUMClient
  • Aws\CodeArtifact\CodeArtifactClient
  • Aws\CodeBuild\CodeBuildClient
  • Aws\CodeCommit\CodeCommitClient
  • Aws\CodeDeploy\CodeDeployClient
  • Aws\CodeGuruProfiler\CodeGuruProfilerClient
  • Aws\CodeGuruReviewer\CodeGuruReviewerClient
  • Aws\CodePipeline\CodePipelineClient
  • Aws\CodeStar\CodeStarClient
  • Aws\CodeStarconnections\CodeStarconnectionsClient
  • Aws\CodeStarNotifications\CodeStarNotificationsClient
  • Aws\CognitoIdentity\CognitoIdentityClient
  • Aws\CognitoIdentity\CognitoIdentityProvider
  • Aws\CognitoIdentityProvider\CognitoIdentityProviderClient
  • Aws\CognitoSync\CognitoSyncClient
  • Aws\Command
  • Aws\CommandPool
  • Aws\Comprehend\ComprehendClient
  • Aws\ComprehendMedical\ComprehendMedicalClient
  • Aws\ComputeOptimizer\ComputeOptimizerClient
  • Aws\ConfigService\ConfigServiceClient
  • Aws\Connect\ConnectClient
  • Aws\ConnectCampaignService\ConnectCampaignServiceClient
  • Aws\ConnectContactLens\ConnectContactLensClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • Aws\ConnectWisdomService\ConnectWisdomServiceClient
  • 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\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\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\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient
  • Aws\IoT1ClickProjects\IoT1ClickProjectsClient
  • Aws\Iot\IotClient
  • Aws\IoTAnalytics\IoTAnalyticsClient
  • Aws\IotDataPlane\IotDataPlaneClient
  • Aws\IoTDeviceAdvisor\IoTDeviceAdvisorClient
  • Aws\IoTEvents\IoTEventsClient
  • Aws\IoTEventsData\IoTEventsDataClient
  • Aws\IoTFleetHub\IoTFleetHubClient
  • Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
  • Aws\IoTSecureTunneling\IoTSecureTunnelingClient
  • Aws\IoTSiteWise\IoTSiteWiseClient
  • Aws\IoTThingsGraph\IoTThingsGraphClient
  • Aws\IoTTwinMaker\IoTTwinMakerClient
  • Aws\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\ivschat\ivschatClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\KafkaConnect\KafkaConnectClient
  • Aws\kendra\kendraClient
  • 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\Kms\KmsClient
  • Aws\LakeFormation\LakeFormationClient
  • Aws\Lambda\LambdaClient
  • Aws\LexModelBuildingService\LexModelBuildingServiceClient
  • Aws\LexModelsV2\LexModelsV2Client
  • Aws\LexRuntimeService\LexRuntimeServiceClient
  • Aws\LexRuntimeV2\LexRuntimeV2Client
  • Aws\LicenseManager\LicenseManagerClient
  • Aws\Lightsail\LightsailClient
  • Aws\LocationService\LocationServiceClient
  • Aws\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\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\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\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • 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\Rekognition\RekognitionClient
  • Aws\ResilienceHub\ResilienceHubClient
  • Aws\ResourceGroups\ResourceGroupsClient
  • Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
  • Aws\Result
  • Aws\ResultPaginator
  • Aws\Retry\Configuration
  • Aws\Retry\ConfigurationProvider
  • Aws\RoboMaker\RoboMakerClient
  • Aws\Route53\Route53Client
  • Aws\Route53Domains\Route53DomainsClient
  • Aws\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\SageMakerRuntime\SageMakerRuntimeClient
  • Aws\SavingsPlans\SavingsPlansClient
  • Aws\Schemas\SchemasClient
  • Aws\Sdk
  • Aws\SecretsManager\SecretsManagerClient
  • Aws\SecurityHub\SecurityHubClient
  • Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient
  • Aws\ServiceCatalog\ServiceCatalogClient
  • Aws\ServiceDiscovery\ServiceDiscoveryClient
  • Aws\ServiceQuotas\ServiceQuotasClient
  • Aws\Ses\SesClient
  • Aws\SesV2\SesV2Client
  • Aws\Sfn\SfnClient
  • Aws\Shield\ShieldClient
  • Aws\Signature\AnonymousSignature
  • Aws\Signature\S3SignatureV4
  • Aws\Signature\SignatureProvider
  • Aws\Signature\SignatureV4
  • Aws\signer\signerClient
  • Aws\Sms\SmsClient
  • Aws\SnowBall\SnowBallClient
  • Aws\SnowDeviceManagement\SnowDeviceManagementClient
  • Aws\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • Aws\SSMContacts\SSMContactsClient
  • Aws\SSMIncidents\SSMIncidentsClient
  • Aws\SSO\SSOClient
  • Aws\SSOAdmin\SSOAdminClient
  • Aws\SSOOIDC\SSOOIDCClient
  • Aws\StorageGateway\StorageGatewayClient
  • Aws\Sts\RegionalEndpoints\Configuration
  • Aws\Sts\RegionalEndpoints\ConfigurationProvider
  • Aws\Sts\StsClient
  • Aws\Support\SupportClient
  • Aws\Swf\SwfClient
  • Aws\Synthetics\SyntheticsClient
  • Aws\Textract\TextractClient
  • Aws\TimestreamQuery\TimestreamQueryClient
  • Aws\TimestreamWrite\TimestreamWriteClient
  • Aws\TraceMiddleware
  • Aws\TranscribeService\TranscribeServiceClient
  • Aws\Transfer\TransferClient
  • Aws\Translate\TranslateClient
  • Aws\VoiceID\VoiceIDClient
  • Aws\Waf\WafClient
  • Aws\WafRegional\WafRegionalClient
  • Aws\WAFV2\WAFV2Client
  • Aws\Waiter
  • Aws\WellArchitected\WellArchitectedClient
  • Aws\WorkDocs\WorkDocsClient
  • Aws\WorkLink\WorkLinkClient
  • Aws\WorkMail\WorkMailClient
  • Aws\WorkMailMessageFlow\WorkMailMessageFlowClient
  • Aws\WorkSpaces\WorkSpacesClient
  • Aws\WorkSpacesWeb\WorkSpacesWebClient
  • Aws\WrappedHttpHandler
  • Aws\XRay\XRayClient

Interfaces

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

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

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\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\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\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\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\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\ConnectContactLens\Exception\ConnectContactLensException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • Aws\ConnectWisdomService\Exception\ConnectWisdomServiceException
  • 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\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\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\IoT1ClickDevicesService\Exception\IoT1ClickDevicesServiceException
  • Aws\IoT1ClickProjects\Exception\IoT1ClickProjectsException
  • Aws\Iot\Exception\IotException
  • Aws\IoTAnalytics\Exception\IoTAnalyticsException
  • Aws\IotDataPlane\Exception\IotDataPlaneException
  • Aws\IoTDeviceAdvisor\Exception\IoTDeviceAdvisorException
  • Aws\IoTEvents\Exception\IoTEventsException
  • Aws\IoTEventsData\Exception\IoTEventsDataException
  • Aws\IoTFleetHub\Exception\IoTFleetHubException
  • Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException
  • Aws\IoTSecureTunneling\Exception\IoTSecureTunnelingException
  • Aws\IoTSiteWise\Exception\IoTSiteWiseException
  • Aws\IoTThingsGraph\Exception\IoTThingsGraphException
  • Aws\IoTTwinMaker\Exception\IoTTwinMakerException
  • Aws\IoTWireless\Exception\IoTWirelessException
  • Aws\IVS\Exception\IVSException
  • Aws\ivschat\Exception\ivschatException
  • Aws\Kafka\Exception\KafkaException
  • Aws\KafkaConnect\Exception\KafkaConnectException
  • Aws\kendra\Exception\kendraException
  • 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\Kms\Exception\KmsException
  • Aws\LakeFormation\Exception\LakeFormationException
  • Aws\Lambda\Exception\LambdaException
  • Aws\LexModelBuildingService\Exception\LexModelBuildingServiceException
  • Aws\LexModelsV2\Exception\LexModelsV2Exception
  • Aws\LexRuntimeService\Exception\LexRuntimeServiceException
  • Aws\LexRuntimeV2\Exception\LexRuntimeV2Exception
  • Aws\LicenseManager\Exception\LicenseManagerException
  • Aws\Lightsail\Exception\LightsailException
  • Aws\LocationService\Exception\LocationServiceException
  • Aws\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\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\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\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • 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\Rekognition\Exception\RekognitionException
  • Aws\ResilienceHub\Exception\ResilienceHubException
  • Aws\ResourceGroups\Exception\ResourceGroupsException
  • Aws\ResourceGroupsTaggingAPI\Exception\ResourceGroupsTaggingAPIException
  • Aws\Retry\Exception\ConfigurationException
  • Aws\RoboMaker\Exception\RoboMakerException
  • Aws\Route53\Exception\Route53Exception
  • Aws\Route53Domains\Exception\Route53DomainsException
  • Aws\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\SageMakerRuntime\Exception\SageMakerRuntimeException
  • Aws\SavingsPlans\Exception\SavingsPlansException
  • Aws\Schemas\Exception\SchemasException
  • Aws\SecretsManager\Exception\SecretsManagerException
  • Aws\SecurityHub\Exception\SecurityHubException
  • Aws\ServerlessApplicationRepository\Exception\ServerlessApplicationRepositoryException
  • Aws\ServiceCatalog\Exception\ServiceCatalogException
  • Aws\ServiceDiscovery\Exception\ServiceDiscoveryException
  • Aws\ServiceQuotas\Exception\ServiceQuotasException
  • Aws\Ses\Exception\SesException
  • Aws\SesV2\Exception\SesV2Exception
  • Aws\Sfn\Exception\SfnException
  • Aws\Shield\Exception\ShieldException
  • Aws\signer\Exception\signerException
  • Aws\Sms\Exception\SmsException
  • Aws\SnowBall\Exception\SnowBallException
  • Aws\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\SSO\Exception\SSOException
  • Aws\SSOAdmin\Exception\SSOAdminException
  • Aws\SSOOIDC\Exception\SSOOIDCException
  • Aws\StorageGateway\Exception\StorageGatewayException
  • Aws\Sts\Exception\StsException
  • Aws\Sts\RegionalEndpoints\Exception\ConfigurationException
  • Aws\Support\Exception\SupportException
  • Aws\Swf\Exception\SwfException
  • Aws\Synthetics\Exception\SyntheticsException
  • Aws\Textract\Exception\TextractException
  • Aws\TimestreamQuery\Exception\TimestreamQueryException
  • Aws\TimestreamWrite\Exception\TimestreamWriteException
  • Aws\TranscribeService\Exception\TranscribeServiceException
  • Aws\Transfer\Exception\TransferException
  • Aws\Translate\Exception\TranslateException
  • Aws\VoiceID\Exception\VoiceIDException
  • Aws\Waf\Exception\WafException
  • Aws\WafRegional\Exception\WafRegionalException
  • Aws\WAFV2\Exception\WAFV2Exception
  • Aws\WellArchitected\Exception\WellArchitectedException
  • Aws\WorkDocs\Exception\WorkDocsException
  • Aws\WorkLink\Exception\WorkLinkException
  • Aws\WorkMail\Exception\WorkMailException
  • Aws\WorkMailMessageFlow\Exception\WorkMailMessageFlowException
  • Aws\WorkSpaces\Exception\WorkSpacesException
  • Aws\WorkSpacesWeb\Exception\WorkSpacesWebException
  • Aws\XRay\Exception\XRayException

Functions

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

AWS Outposts 2019-12-03

Client: Aws\Outposts\OutpostsClient
Service ID: outposts
Version: 2019-12-03

This page describes the parameters and results for the operations of the AWS Outposts (2019-12-03), and shows how to use the Aws\Outposts\OutpostsClient object to call the described operations. This documentation is specific to the 2019-12-03 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 */).

  • CancelOrder ( array $params = [] )

    Cancels an order for an Outpost.

  • CreateOrder ( array $params = [] )

    Creates an order for an Outpost.

  • CreateOutpost ( array $params = [] )

    Creates an Outpost.

  • CreateSite ( array $params = [] )

    Creates a site for an Outpost.

  • DeleteOutpost ( array $params = [] )

    Deletes the Outpost.

  • DeleteSite ( array $params = [] )

    Deletes the site.

  • GetCatalogItem ( array $params = [] )

    Gets information about a catalog item.

  • GetConnection ( array $params = [] )

    Amazon Web Services uses this action to install Outpost servers.

  • GetOrder ( array $params = [] )

    Gets an order.

  • GetOutpost ( array $params = [] )

    Gets information about the specified Outpost.

  • GetOutpostInstanceTypes ( array $params = [] )

    Gets the instance types for the specified Outpost.

  • GetSite ( array $params = [] )

    Gets information about the specified Outpost site.

  • GetSiteAddress ( array $params = [] )

    Gets the site address.

  • ListAssets ( array $params = [] )

    Lists the hardware assets in an Outpost.

  • ListCatalogItems ( array $params = [] )

    Lists the items in the catalog.

  • ListOrders ( array $params = [] )

    Lists the Outpost orders for your Amazon Web Services account.

  • ListOutposts ( array $params = [] )

    Lists the Outposts for your Amazon Web Services account.

  • ListSites ( array $params = [] )

    Lists the Outpost sites for your Amazon Web Services account.

  • ListTagsForResource ( array $params = [] )

    Lists the tags for the specified resource.

  • StartConnection ( array $params = [] )

    Amazon Web Services uses this action to install Outpost servers.

  • TagResource ( array $params = [] )

    Adds tags to the specified resource.

  • UntagResource ( array $params = [] )

    Removes tags from the specified resource.

  • UpdateOutpost ( array $params = [] )

    Updates an Outpost.

  • UpdateSite ( array $params = [] )

    Updates the site.

  • UpdateSiteAddress ( array $params = [] )

    Updates the site address.

  • UpdateSiteRackPhysicalProperties ( array $params = [] )

    Update the physical and logistical details for a rack at a site.

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:

  • GetOutpostInstanceTypes
  • ListAssets
  • ListCatalogItems
  • ListOrders
  • ListOutposts
  • ListSites

Operations

CancelOrder

$result = $client->cancelOrder([/* ... */]);
$promise = $client->cancelOrderAsync([/* ... */]);

Cancels an order for an Outpost.

Parameter Syntax

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

Parameter Details

Members
OrderId
  • Required: Yes
  • Type: string

The ID of the order to cancel.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    A parameter is not valid.

  • ConflictException:

    Updating or deleting this resource can cause an inconsistent state.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • NotFoundException:

    The specified request is not valid.

  • InternalServerException:

    An internal error has occurred.

CreateOrder

$result = $client->createOrder([/* ... */]);
$promise = $client->createOrderAsync([/* ... */]);

Creates an order for an Outpost.

Parameter Syntax

$result = $client->createOrder([
    'LineItems' => [ // REQUIRED
        [
            'CatalogItemId' => '<string>',
            'Quantity' => <integer>,
        ],
        // ...
    ],
    'OutpostIdentifier' => '<string>', // REQUIRED
    'PaymentOption' => 'ALL_UPFRONT|NO_UPFRONT|PARTIAL_UPFRONT', // REQUIRED
    'PaymentTerm' => 'THREE_YEARS',
]);

Parameter Details

Members
LineItems
  • Required: Yes
  • Type: Array of LineItemRequest structures

The line items that make up the order.

OutpostIdentifier
  • Required: Yes
  • Type: string

The ID or the Amazon Resource Name (ARN) of the Outpost.

PaymentOption
  • Required: Yes
  • Type: string

The payment option for the order.

PaymentTerm
  • Type: string

The payment terms for the order.

Result Syntax

[
    'Order' => [
        'LineItems' => [
            [
                'CatalogItemId' => '<string>',
                'LineItemId' => '<string>',
                'Quantity' => <integer>,
                'Status' => 'PREPARING|BUILDING|SHIPPED|DELIVERED|INSTALLING|INSTALLED|ERROR|CANCELLED',
            ],
            // ...
        ],
        'OrderFulfilledDate' => <DateTime>,
        'OrderId' => '<string>',
        'OrderSubmissionDate' => <DateTime>,
        'OutpostId' => '<string>',
        'PaymentOption' => 'ALL_UPFRONT|NO_UPFRONT|PARTIAL_UPFRONT',
        'Status' => 'RECEIVED|PENDING|PROCESSING|INSTALLING|FULFILLED|CANCELLED|PREPARING|IN_PROGRESS|COMPLETED|ERROR',
    ],
]

Result Details

Members
Order
  • Type: Order structure

Information about this order.

Errors

  • ValidationException:

    A parameter is not valid.

  • ConflictException:

    Updating or deleting this resource can cause an inconsistent state.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • NotFoundException:

    The specified request is not valid.

  • InternalServerException:

    An internal error has occurred.

  • ServiceQuotaExceededException:

    You have exceeded a service quota.

CreateOutpost

$result = $client->createOutpost([/* ... */]);
$promise = $client->createOutpostAsync([/* ... */]);

Creates an Outpost.

You can specify AvailabilityZone or AvailabilityZoneId.

Parameter Syntax

$result = $client->createOutpost([
    'AvailabilityZone' => '<string>',
    'AvailabilityZoneId' => '<string>',
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'SiteId' => '<string>', // REQUIRED
    'SupportedHardwareType' => 'RACK|SERVER',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
AvailabilityZone
  • Type: string

The Availability Zone.

AvailabilityZoneId
  • Type: string

The ID of the Availability Zone.

Description
  • Type: string

The description of the Outpost.

Name
  • Required: Yes
  • Type: string

The name of the Outpost.

SiteId
  • Required: Yes
  • Type: string

The ID or the Amazon Resource Name (ARN) of the site.

In requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and sites throughout the Outposts Query API. To address backwards compatibility, the parameter names OutpostID or SiteID remain in use. Despite the parameter name, you can make the request with an ARN.

SupportedHardwareType
  • Type: string

The type of hardware for this Outpost.

Tags
  • Type: Associative array of custom strings keys (TagKey) to strings

The tags to apply to the Outpost.

Result Syntax

[
    'Outpost' => [
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneId' => '<string>',
        'Description' => '<string>',
        'LifeCycleStatus' => '<string>',
        'Name' => '<string>',
        'OutpostArn' => '<string>',
        'OutpostId' => '<string>',
        'OwnerId' => '<string>',
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'SupportedHardwareType' => 'RACK|SERVER',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
Outpost
  • Type: Outpost structure

Information about an Outpost.

Errors

  • ValidationException:

    A parameter is not valid.

  • ConflictException:

    Updating or deleting this resource can cause an inconsistent state.

  • NotFoundException:

    The specified request is not valid.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • InternalServerException:

    An internal error has occurred.

  • ServiceQuotaExceededException:

    You have exceeded a service quota.

CreateSite

$result = $client->createSite([/* ... */]);
$promise = $client->createSiteAsync([/* ... */]);

Creates a site for an Outpost.

Parameter Syntax

$result = $client->createSite([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Notes' => '<string>',
    'OperatingAddress' => [
        'AddressLine1' => '<string>', // REQUIRED
        'AddressLine2' => '<string>',
        'AddressLine3' => '<string>',
        'City' => '<string>', // REQUIRED
        'ContactName' => '<string>',
        'ContactPhoneNumber' => '<string>',
        'CountryCode' => '<string>', // REQUIRED
        'DistrictOrCounty' => '<string>',
        'Municipality' => '<string>',
        'PostalCode' => '<string>', // REQUIRED
        'StateOrRegion' => '<string>', // REQUIRED
    ],
    'RackPhysicalProperties' => [
        'FiberOpticCableType' => 'SINGLE_MODE|MULTI_MODE',
        'MaximumSupportedWeightLbs' => 'NO_LIMIT|MAX_1400_LBS|MAX_1600_LBS|MAX_1800_LBS|MAX_2000_LBS',
        'OpticalStandard' => 'OPTIC_10GBASE_SR|OPTIC_10GBASE_IR|OPTIC_10GBASE_LR|OPTIC_40GBASE_SR|OPTIC_40GBASE_ESR|OPTIC_40GBASE_IR4_LR4L|OPTIC_40GBASE_LR4|OPTIC_100GBASE_SR4|OPTIC_100GBASE_CWDM4|OPTIC_100GBASE_LR4|OPTIC_100G_PSM4_MSA|OPTIC_1000BASE_LX|OPTIC_1000BASE_SX',
        'PowerConnector' => 'L6_30P|IEC309|AH530P7W|AH532P6W',
        'PowerDrawKva' => 'POWER_5_KVA|POWER_10_KVA|POWER_15_KVA',
        'PowerFeedDrop' => 'ABOVE_RACK|BELOW_RACK',
        'PowerPhase' => 'SINGLE_PHASE|THREE_PHASE',
        'UplinkCount' => 'UPLINK_COUNT_1|UPLINK_COUNT_2|UPLINK_COUNT_3|UPLINK_COUNT_4|UPLINK_COUNT_5|UPLINK_COUNT_6|UPLINK_COUNT_7|UPLINK_COUNT_8|UPLINK_COUNT_12|UPLINK_COUNT_16',
        'UplinkGbps' => 'UPLINK_1G|UPLINK_10G|UPLINK_40G|UPLINK_100G',
    ],
    'ShippingAddress' => [
        'AddressLine1' => '<string>', // REQUIRED
        'AddressLine2' => '<string>',
        'AddressLine3' => '<string>',
        'City' => '<string>', // REQUIRED
        'ContactName' => '<string>',
        'ContactPhoneNumber' => '<string>',
        'CountryCode' => '<string>', // REQUIRED
        'DistrictOrCounty' => '<string>',
        'Municipality' => '<string>',
        'PostalCode' => '<string>', // REQUIRED
        'StateOrRegion' => '<string>', // REQUIRED
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
Description
  • Type: string

The description of the site.

Name
  • Required: Yes
  • Type: string

The name of the site.

Notes
  • Type: string

Additional information that you provide about site access requirements, electrician scheduling, personal protective equipment, or regulation of equipment materials that could affect your installation process.

OperatingAddress
  • Type: Address structure

The location to install and power on the hardware. This address might be different from the shipping address.

RackPhysicalProperties
  • Type: RackPhysicalProperties structure

Information about the physical and logistical details for the rack at this site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.

ShippingAddress
  • Type: Address structure

The location to ship the hardware. This address might be different from the operating address.

Tags
  • Type: Associative array of custom strings keys (TagKey) to strings

The tags to apply to a site.

Result Syntax

[
    'Site' => [
        'AccountId' => '<string>',
        'Description' => '<string>',
        'Name' => '<string>',
        'Notes' => '<string>',
        'OperatingAddressCity' => '<string>',
        'OperatingAddressCountryCode' => '<string>',
        'OperatingAddressStateOrRegion' => '<string>',
        'RackPhysicalProperties' => [
            'FiberOpticCableType' => 'SINGLE_MODE|MULTI_MODE',
            'MaximumSupportedWeightLbs' => 'NO_LIMIT|MAX_1400_LBS|MAX_1600_LBS|MAX_1800_LBS|MAX_2000_LBS',
            'OpticalStandard' => 'OPTIC_10GBASE_SR|OPTIC_10GBASE_IR|OPTIC_10GBASE_LR|OPTIC_40GBASE_SR|OPTIC_40GBASE_ESR|OPTIC_40GBASE_IR4_LR4L|OPTIC_40GBASE_LR4|OPTIC_100GBASE_SR4|OPTIC_100GBASE_CWDM4|OPTIC_100GBASE_LR4|OPTIC_100G_PSM4_MSA|OPTIC_1000BASE_LX|OPTIC_1000BASE_SX',
            'PowerConnector' => 'L6_30P|IEC309|AH530P7W|AH532P6W',
            'PowerDrawKva' => 'POWER_5_KVA|POWER_10_KVA|POWER_15_KVA',
            'PowerFeedDrop' => 'ABOVE_RACK|BELOW_RACK',
            'PowerPhase' => 'SINGLE_PHASE|THREE_PHASE',
            'UplinkCount' => 'UPLINK_COUNT_1|UPLINK_COUNT_2|UPLINK_COUNT_3|UPLINK_COUNT_4|UPLINK_COUNT_5|UPLINK_COUNT_6|UPLINK_COUNT_7|UPLINK_COUNT_8|UPLINK_COUNT_12|UPLINK_COUNT_16',
            'UplinkGbps' => 'UPLINK_1G|UPLINK_10G|UPLINK_40G|UPLINK_100G',
        ],
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
Site
  • Type: Site structure

Information about a site.

Errors

  • ValidationException:

    A parameter is not valid.

  • ConflictException:

    Updating or deleting this resource can cause an inconsistent state.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • InternalServerException:

    An internal error has occurred.

  • ServiceQuotaExceededException:

    You have exceeded a service quota.

DeleteOutpost

$result = $client->deleteOutpost([/* ... */]);
$promise = $client->deleteOutpostAsync([/* ... */]);

Deletes the Outpost.

Parameter Syntax

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

Parameter Details

Members
OutpostId
  • Required: Yes
  • Type: string

The ID or the Amazon Resource Name (ARN) of the Outpost.

In requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and sites throughout the Outposts Query API. To address backwards compatibility, the parameter names OutpostID or SiteID remain in use. Despite the parameter name, you can make the request with an ARN.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    A parameter is not valid.

  • ConflictException:

    Updating or deleting this resource can cause an inconsistent state.

  • NotFoundException:

    The specified request is not valid.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • InternalServerException:

    An internal error has occurred.

DeleteSite

$result = $client->deleteSite([/* ... */]);
$promise = $client->deleteSiteAsync([/* ... */]);

Deletes the site.

Parameter Syntax

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

Parameter Details

Members
SiteId
  • Required: Yes
  • Type: string

The ID or the Amazon Resource Name (ARN) of the site.

In requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and sites throughout the Outposts Query API. To address backwards compatibility, the parameter names OutpostID or SiteID remain in use. Despite the parameter name, you can make the request with an ARN.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    A parameter is not valid.

  • ConflictException:

    Updating or deleting this resource can cause an inconsistent state.

  • NotFoundException:

    The specified request is not valid.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • InternalServerException:

    An internal error has occurred.

GetCatalogItem

$result = $client->getCatalogItem([/* ... */]);
$promise = $client->getCatalogItemAsync([/* ... */]);

Gets information about a catalog item.

Parameter Syntax

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

Parameter Details

Members
CatalogItemId
  • Required: Yes
  • Type: string

The ID of the catalog item.

Result Syntax

[
    'CatalogItem' => [
        'CatalogItemId' => '<string>',
        'EC2Capacities' => [
            [
                'Family' => '<string>',
                'MaxSize' => '<string>',
                'Quantity' => '<string>',
            ],
            // ...
        ],
        'ItemStatus' => 'AVAILABLE|DISCONTINUED',
        'PowerKva' => <float>,
        'SupportedStorage' => ['<string>', ...],
        'SupportedUplinkGbps' => [<integer>, ...],
        'WeightLbs' => <integer>,
    ],
]

Result Details

Members
CatalogItem
  • Type: CatalogItem structure

Information about this catalog item.

Errors

  • ValidationException:

    A parameter is not valid.

  • NotFoundException:

    The specified request is not valid.

  • InternalServerException:

    An internal error has occurred.

GetConnection

$result = $client->getConnection([/* ... */]);
$promise = $client->getConnectionAsync([/* ... */]);

Amazon Web Services uses this action to install Outpost servers.

Gets information about a specified connection.

Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

Parameter Syntax

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

Parameter Details

Members
ConnectionId
  • Required: Yes
  • Type: string

The ID of the connection you request.

Result Syntax

[
    'ConnectionDetails' => [
        'AllowedIps' => ['<string>', ...],
        'ClientPublicKey' => '<string>',
        'ClientTunnelAddress' => '<string>',
        'ServerEndpoint' => '<string>',
        'ServerPublicKey' => '<string>',
        'ServerTunnelAddress' => '<string>',
    ],
    'ConnectionId' => '<string>',
]

Result Details

Members
ConnectionDetails
  • Type: ConnectionDetails structure

Information about a connection.

ConnectionId
  • Type: string

The ID of the connection you receive.

Errors

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • ValidationException:

    A parameter is not valid.

  • NotFoundException:

    The specified request is not valid.

  • InternalServerException:

    An internal error has occurred.

GetOrder

$result = $client->getOrder([/* ... */]);
$promise = $client->getOrderAsync([/* ... */]);

Gets an order.

Parameter Syntax

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

Parameter Details

Members
OrderId
  • Required: Yes
  • Type: string

The ID of the order.

Result Syntax

[
    'Order' => [
        'LineItems' => [
            [
                'CatalogItemId' => '<string>',
                'LineItemId' => '<string>',
                'Quantity' => <integer>,
                'Status' => 'PREPARING|BUILDING|SHIPPED|DELIVERED|INSTALLING|INSTALLED|ERROR|CANCELLED',
            ],
            // ...
        ],
        'OrderFulfilledDate' => <DateTime>,
        'OrderId' => '<string>',
        'OrderSubmissionDate' => <DateTime>,
        'OutpostId' => '<string>',
        'PaymentOption' => 'ALL_UPFRONT|NO_UPFRONT|PARTIAL_UPFRONT',
        'Status' => 'RECEIVED|PENDING|PROCESSING|INSTALLING|FULFILLED|CANCELLED|PREPARING|IN_PROGRESS|COMPLETED|ERROR',
    ],
]

Result Details

Members
Order
  • Type: Order structure

Information about an order.

Errors

  • ValidationException:

    A parameter is not valid.

  • NotFoundException:

    The specified request is not valid.

  • InternalServerException:

    An internal error has occurred.

GetOutpost

$result = $client->getOutpost([/* ... */]);
$promise = $client->getOutpostAsync([/* ... */]);

Gets information about the specified Outpost.

Parameter Syntax

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

Parameter Details

Members
OutpostId
  • Required: Yes
  • Type: string

The ID or the Amazon Resource Name (ARN) of the Outpost.

In requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and sites throughout the Outposts Query API. To address backwards compatibility, the parameter names OutpostID or SiteID remain in use. Despite the parameter name, you can make the request with an ARN.

Result Syntax

[
    'Outpost' => [
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneId' => '<string>',
        'Description' => '<string>',
        'LifeCycleStatus' => '<string>',
        'Name' => '<string>',
        'OutpostArn' => '<string>',
        'OutpostId' => '<string>',
        'OwnerId' => '<string>',
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'SupportedHardwareType' => 'RACK|SERVER',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
Outpost
  • Type: Outpost structure

Information about an Outpost.

Errors

  • ValidationException:

    A parameter is not valid.

  • NotFoundException:

    The specified request is not valid.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • InternalServerException:

    An internal error has occurred.

GetOutpostInstanceTypes

$result = $client->getOutpostInstanceTypes([/* ... */]);
$promise = $client->getOutpostInstanceTypesAsync([/* ... */]);

Gets the instance types for the specified Outpost.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum page size.

NextToken
  • Type: string

The pagination token.

OutpostId
  • Required: Yes
  • Type: string

The ID or the Amazon Resource Name (ARN) of the Outpost.

In requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and sites throughout the Outposts Query API. To address backwards compatibility, the parameter names OutpostID or SiteID remain in use. Despite the parameter name, you can make the request with an ARN.

Result Syntax

[
    'InstanceTypes' => [
        [
            'InstanceType' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'OutpostArn' => '<string>',
    'OutpostId' => '<string>',
]

Result Details

Members
InstanceTypes
  • Type: Array of InstanceTypeItem structures

Information about the instance types.

NextToken
  • Type: string

The pagination token.

OutpostArn
  • Type: string

The Amazon Resource Name (ARN) of the Outpost.

OutpostId
  • Type: string

The ID of the Outpost.

In requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and sites throughout the Outposts Query API. To address backwards compatibility, the parameter names OutpostID or SiteID remain in use. Despite the parameter name, you can make the request with an ARN.

Errors

  • ValidationException:

    A parameter is not valid.

  • NotFoundException:

    The specified request is not valid.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • InternalServerException:

    An internal error has occurred.

GetSite

$result = $client->getSite([/* ... */]);
$promise = $client->getSiteAsync([/* ... */]);

Gets information about the specified Outpost site.

Parameter Syntax

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

Parameter Details

Members
SiteId
  • Required: Yes
  • Type: string

The ID or the Amazon Resource Name (ARN) of the site.

In requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and sites throughout the Outposts Query API. To address backwards compatibility, the parameter names OutpostID or SiteID remain in use. Despite the parameter name, you can make the request with an ARN.

Result Syntax

[
    'Site' => [
        'AccountId' => '<string>',
        'Description' => '<string>',
        'Name' => '<string>',
        'Notes' => '<string>',
        'OperatingAddressCity' => '<string>',
        'OperatingAddressCountryCode' => '<string>',
        'OperatingAddressStateOrRegion' => '<string>',
        'RackPhysicalProperties' => [
            'FiberOpticCableType' => 'SINGLE_MODE|MULTI_MODE',
            'MaximumSupportedWeightLbs' => 'NO_LIMIT|MAX_1400_LBS|MAX_1600_LBS|MAX_1800_LBS|MAX_2000_LBS',
            'OpticalStandard' => 'OPTIC_10GBASE_SR|OPTIC_10GBASE_IR|OPTIC_10GBASE_LR|OPTIC_40GBASE_SR|OPTIC_40GBASE_ESR|OPTIC_40GBASE_IR4_LR4L|OPTIC_40GBASE_LR4|OPTIC_100GBASE_SR4|OPTIC_100GBASE_CWDM4|OPTIC_100GBASE_LR4|OPTIC_100G_PSM4_MSA|OPTIC_1000BASE_LX|OPTIC_1000BASE_SX',
            'PowerConnector' => 'L6_30P|IEC309|AH530P7W|AH532P6W',
            'PowerDrawKva' => 'POWER_5_KVA|POWER_10_KVA|POWER_15_KVA',
            'PowerFeedDrop' => 'ABOVE_RACK|BELOW_RACK',
            'PowerPhase' => 'SINGLE_PHASE|THREE_PHASE',
            'UplinkCount' => 'UPLINK_COUNT_1|UPLINK_COUNT_2|UPLINK_COUNT_3|UPLINK_COUNT_4|UPLINK_COUNT_5|UPLINK_COUNT_6|UPLINK_COUNT_7|UPLINK_COUNT_8|UPLINK_COUNT_12|UPLINK_COUNT_16',
            'UplinkGbps' => 'UPLINK_1G|UPLINK_10G|UPLINK_40G|UPLINK_100G',
        ],
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
Site
  • Type: Site structure

Information about a site.

Errors

  • ValidationException:

    A parameter is not valid.

  • NotFoundException:

    The specified request is not valid.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • InternalServerException:

    An internal error has occurred.

GetSiteAddress

$result = $client->getSiteAddress([/* ... */]);
$promise = $client->getSiteAddressAsync([/* ... */]);

Gets the site address.

Parameter Syntax

$result = $client->getSiteAddress([
    'AddressType' => 'SHIPPING_ADDRESS|OPERATING_ADDRESS', // REQUIRED
    'SiteId' => '<string>', // REQUIRED
]);

Parameter Details

Members
AddressType
  • Required: Yes
  • Type: string

The type of the address you request.

SiteId
  • Required: Yes
  • Type: string

The ID or the Amazon Resource Name (ARN) of the site.

In requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and sites throughout the Outposts Query API. To address backwards compatibility, the parameter names OutpostID or SiteID remain in use. Despite the parameter name, you can make the request with an ARN.

Result Syntax

[
    'Address' => [
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'AddressLine3' => '<string>',
        'City' => '<string>',
        'ContactName' => '<string>',
        'ContactPhoneNumber' => '<string>',
        'CountryCode' => '<string>',
        'DistrictOrCounty' => '<string>',
        'Municipality' => '<string>',
        'PostalCode' => '<string>',
        'StateOrRegion' => '<string>',
    ],
    'AddressType' => 'SHIPPING_ADDRESS|OPERATING_ADDRESS',
    'SiteId' => '<string>',
]

Result Details

Members
Address
  • Type: Address structure

Information about the address.

AddressType
  • Type: string

The type of the address you receive.

SiteId
  • Type: string

The ID of the site.

Errors

  • ValidationException:

    A parameter is not valid.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • NotFoundException:

    The specified request is not valid.

  • InternalServerException:

    An internal error has occurred.

ListAssets

$result = $client->listAssets([/* ... */]);
$promise = $client->listAssetsAsync([/* ... */]);

Lists the hardware assets in an Outpost. If you are using Dedicated Hosts on Amazon Web Services Outposts, you can filter your request by host ID to return a list of hardware assets that allocate resources for Dedicated Hosts.

Parameter Syntax

$result = $client->listAssets([
    'HostIdFilter' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OutpostIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
HostIdFilter
  • Type: Array of strings

A filter for the host ID of Dedicated Hosts on the Outpost.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

MaxResults
  • Type: int

The maximum page size.

NextToken
  • Type: string

The pagination token.

OutpostIdentifier
  • Required: Yes
  • Type: string

The ID or the Amazon Resource Name (ARN) of the Outpost.

Result Syntax

[
    'Assets' => [
        [
            'AssetId' => '<string>',
            'AssetLocation' => [
                'RackElevation' => <float>,
            ],
            'AssetType' => 'COMPUTE',
            'ComputeAttributes' => [
                'HostId' => '<string>',
            ],
            'RackId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Assets
  • Type: Array of AssetInfo structures

Information about hardware assets.

NextToken
  • Type: string

The pagination token.

Errors

  • ValidationException:

    A parameter is not valid.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • NotFoundException:

    The specified request is not valid.

  • InternalServerException:

    An internal error has occurred.

ListCatalogItems

$result = $client->listCatalogItems([/* ... */]);
$promise = $client->listCatalogItemsAsync([/* ... */]);

Lists the items in the catalog. Add filters to your request to return a more specific list of results. Use filters to match an item class, storage option, or EC2 family.

If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

Parameter Syntax

$result = $client->listCatalogItems([
    'EC2FamilyFilter' => ['<string>', ...],
    'ItemClassFilter' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SupportedStorageFilter' => ['<string>', ...],
]);

Parameter Details

Members
EC2FamilyFilter
  • Type: Array of strings

A filter for EC2 family options for items in the catalog.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

ItemClassFilter
  • Type: Array of strings

A filter for the class of items in the catalog.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

MaxResults
  • Type: int

The maximum page size.

NextToken
  • Type: string

The pagination token.

SupportedStorageFilter
  • Type: Array of strings

A filter for the storage options of items in the catalog.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

Result Syntax

[
    'CatalogItems' => [
        [
            'CatalogItemId' => '<string>',
            'EC2Capacities' => [
                [
                    'Family' => '<string>',
                    'MaxSize' => '<string>',
                    'Quantity' => '<string>',
                ],
                // ...
            ],
            'ItemStatus' => 'AVAILABLE|DISCONTINUED',
            'PowerKva' => <float>,
            'SupportedStorage' => ['<string>', ...],
            'SupportedUplinkGbps' => [<integer>, ...],
            'WeightLbs' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
CatalogItems
  • Type: Array of CatalogItem structures

Information about the catalog items.

NextToken
  • Type: string

The pagination token.

Errors

  • ValidationException:

    A parameter is not valid.

  • NotFoundException:

    The specified request is not valid.

  • InternalServerException:

    An internal error has occurred.

ListOrders

$result = $client->listOrders([/* ... */]);
$promise = $client->listOrdersAsync([/* ... */]);

Lists the Outpost orders for your Amazon Web Services account. You can filter your request by Outpost to return a more specific list of results.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum page size.

NextToken
  • Type: string

The pagination token.

OutpostIdentifierFilter
  • Type: string

The ID or the Amazon Resource Name (ARN) of the Outpost.

Result Syntax

[
    'NextToken' => '<string>',
    'Orders' => [
        [
            'LineItemCountsByStatus' => [<integer>, ...],
            'OrderFulfilledDate' => <DateTime>,
            'OrderId' => '<string>',
            'OrderSubmissionDate' => <DateTime>,
            'OrderType' => 'OUTPOST|REPLACEMENT',
            'OutpostId' => '<string>',
            'Status' => 'RECEIVED|PENDING|PROCESSING|INSTALLING|FULFILLED|CANCELLED|PREPARING|IN_PROGRESS|COMPLETED|ERROR',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The pagination token.

Orders
  • Type: Array of OrderSummary structures

Information about the orders.

Errors

  • ValidationException:

    A parameter is not valid.

  • NotFoundException:

    The specified request is not valid.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • InternalServerException:

    An internal error has occurred.

ListOutposts

$result = $client->listOutposts([/* ... */]);
$promise = $client->listOutpostsAsync([/* ... */]);

Lists the Outposts for your Amazon Web Services account. Add filters to your request to return a more specific list of results. Use filters to match an Outpost lifecycle status, Availability Zone (us-east-1a), and AZ ID (use1-az1).

If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

Parameter Syntax

$result = $client->listOutposts([
    'AvailabilityZoneFilter' => ['<string>', ...],
    'AvailabilityZoneIdFilter' => ['<string>', ...],
    'LifeCycleStatusFilter' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
AvailabilityZoneFilter
  • Type: Array of strings

A filter for the Availability Zone (us-east-1a) of the Outpost.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

AvailabilityZoneIdFilter
  • Type: Array of strings

A filter for the AZ IDs (use1-az1) of the Outpost.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

LifeCycleStatusFilter
  • Type: Array of strings

A filter for the lifecycle status of the Outpost.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

MaxResults
  • Type: int

The maximum page size.

NextToken
  • Type: string

The pagination token.

Result Syntax

[
    'NextToken' => '<string>',
    'Outposts' => [
        [
            'AvailabilityZone' => '<string>',
            'AvailabilityZoneId' => '<string>',
            'Description' => '<string>',
            'LifeCycleStatus' => '<string>',
            'Name' => '<string>',
            'OutpostArn' => '<string>',
            'OutpostId' => '<string>',
            'OwnerId' => '<string>',
            'SiteArn' => '<string>',
            'SiteId' => '<string>',
            'SupportedHardwareType' => 'RACK|SERVER',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The pagination token.

Outposts
  • Type: Array of Outpost structures

Information about the Outposts.

Errors

  • ValidationException:

    A parameter is not valid.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • InternalServerException:

    An internal error has occurred.

ListSites

$result = $client->listSites([/* ... */]);
$promise = $client->listSitesAsync([/* ... */]);

Lists the Outpost sites for your Amazon Web Services account. Add operating address filters to your request to return a more specific list of results. Use filters to match site city, country code, or state/region of the operating address.

If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

Parameter Syntax

$result = $client->listSites([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OperatingAddressCityFilter' => ['<string>', ...],
    'OperatingAddressCountryCodeFilter' => ['<string>', ...],
    'OperatingAddressStateOrRegionFilter' => ['<string>', ...],
]);

Parameter Details

Members
MaxResults
  • Type: int

The maximum page size.

NextToken
  • Type: string

The pagination token.

OperatingAddressCityFilter
  • Type: Array of strings

A filter for the city of the Outpost site.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

OperatingAddressCountryCodeFilter
  • Type: Array of strings

A filter for the country code of the Outpost site.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

OperatingAddressStateOrRegionFilter
  • Type: Array of strings

A filter for the state/region of the Outpost site.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

Result Syntax

[
    'NextToken' => '<string>',
    'Sites' => [
        [
            'AccountId' => '<string>',
            'Description' => '<string>',
            'Name' => '<string>',
            'Notes' => '<string>',
            'OperatingAddressCity' => '<string>',
            'OperatingAddressCountryCode' => '<string>',
            'OperatingAddressStateOrRegion' => '<string>',
            'RackPhysicalProperties' => [
                'FiberOpticCableType' => 'SINGLE_MODE|MULTI_MODE',
                'MaximumSupportedWeightLbs' => 'NO_LIMIT|MAX_1400_LBS|MAX_1600_LBS|MAX_1800_LBS|MAX_2000_LBS',
                'OpticalStandard' => 'OPTIC_10GBASE_SR|OPTIC_10GBASE_IR|OPTIC_10GBASE_LR|OPTIC_40GBASE_SR|OPTIC_40GBASE_ESR|OPTIC_40GBASE_IR4_LR4L|OPTIC_40GBASE_LR4|OPTIC_100GBASE_SR4|OPTIC_100GBASE_CWDM4|OPTIC_100GBASE_LR4|OPTIC_100G_PSM4_MSA|OPTIC_1000BASE_LX|OPTIC_1000BASE_SX',
                'PowerConnector' => 'L6_30P|IEC309|AH530P7W|AH532P6W',
                'PowerDrawKva' => 'POWER_5_KVA|POWER_10_KVA|POWER_15_KVA',
                'PowerFeedDrop' => 'ABOVE_RACK|BELOW_RACK',
                'PowerPhase' => 'SINGLE_PHASE|THREE_PHASE',
                'UplinkCount' => 'UPLINK_COUNT_1|UPLINK_COUNT_2|UPLINK_COUNT_3|UPLINK_COUNT_4|UPLINK_COUNT_5|UPLINK_COUNT_6|UPLINK_COUNT_7|UPLINK_COUNT_8|UPLINK_COUNT_12|UPLINK_COUNT_16',
                'UplinkGbps' => 'UPLINK_1G|UPLINK_10G|UPLINK_40G|UPLINK_100G',
            ],
            'SiteArn' => '<string>',
            'SiteId' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The pagination token.

Sites
  • Type: Array of Site structures

Information about the sites.

Errors

  • ValidationException:

    A parameter is not valid.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • InternalServerException:

    An internal error has occurred.

ListTagsForResource

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

Lists the tags for the specified resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members
Tags
  • Type: Associative array of custom strings keys (TagKey) to strings

The resource tags.

Errors

  • InternalServerException:

    An internal error has occurred.

  • ValidationException:

    A parameter is not valid.

  • NotFoundException:

    The specified request is not valid.

StartConnection

$result = $client->startConnection([/* ... */]);
$promise = $client->startConnectionAsync([/* ... */]);

Amazon Web Services uses this action to install Outpost servers.

Starts the connection required for Outpost server installation.

Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

Parameter Syntax

$result = $client->startConnection([
    'AssetId' => '<string>', // REQUIRED
    'ClientPublicKey' => '<string>', // REQUIRED
    'DeviceSerialNumber' => '<string>', // REQUIRED
    'NetworkInterfaceDeviceIndex' => <integer>, // REQUIRED
]);

Parameter Details

Members
AssetId
  • Required: Yes
  • Type: string

The ID of the Outpost server.

ClientPublicKey
  • Required: Yes
  • Type: string

The public key of the client.

DeviceSerialNumber
  • Required: Yes
  • Type: string

The serial number of the dongle.

NetworkInterfaceDeviceIndex
  • Required: Yes
  • Type: int

The device index of the network interface on the Outpost server.

Result Syntax

[
    'ConnectionId' => '<string>',
    'UnderlayIpAddress' => '<string>',
]

Result Details

Members
ConnectionId
  • Type: string

The ID of the connection.

UnderlayIpAddress
  • Type: string

The underlay IP address.

Errors

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • ValidationException:

    A parameter is not valid.

  • NotFoundException:

    The specified request is not valid.

  • InternalServerException:

    An internal error has occurred.

TagResource

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

Adds tags to the specified resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource.

Tags
  • Required: Yes
  • Type: Associative array of custom strings keys (TagKey) to strings

The tags to add to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalServerException:

    An internal error has occurred.

  • ValidationException:

    A parameter is not valid.

  • NotFoundException:

    The specified request is not valid.

UntagResource

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

Removes tags from the specified resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource.

TagKeys
  • Required: Yes
  • Type: Array of strings

The tag keys.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalServerException:

    An internal error has occurred.

  • ValidationException:

    A parameter is not valid.

  • NotFoundException:

    The specified request is not valid.

UpdateOutpost

$result = $client->updateOutpost([/* ... */]);
$promise = $client->updateOutpostAsync([/* ... */]);

Updates an Outpost.

Parameter Syntax

$result = $client->updateOutpost([
    'Description' => '<string>',
    'Name' => '<string>',
    'OutpostId' => '<string>', // REQUIRED
    'SupportedHardwareType' => 'RACK|SERVER',
]);

Parameter Details

Members
Description
  • Type: string

The description of the Outpost.

Name
  • Type: string

The name of the Outpost.

OutpostId
  • Required: Yes
  • Type: string

The ID or the Amazon Resource Name (ARN) of the Outpost.

In requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and sites throughout the Outposts Query API. To address backwards compatibility, the parameter names OutpostID or SiteID remain in use. Despite the parameter name, you can make the request with an ARN.

SupportedHardwareType
  • Type: string

The type of hardware for this Outpost.

Result Syntax

[
    'Outpost' => [
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneId' => '<string>',
        'Description' => '<string>',
        'LifeCycleStatus' => '<string>',
        'Name' => '<string>',
        'OutpostArn' => '<string>',
        'OutpostId' => '<string>',
        'OwnerId' => '<string>',
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'SupportedHardwareType' => 'RACK|SERVER',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
Outpost
  • Type: Outpost structure

Information about an Outpost.

Errors

  • ValidationException:

    A parameter is not valid.

  • ConflictException:

    Updating or deleting this resource can cause an inconsistent state.

  • NotFoundException:

    The specified request is not valid.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • InternalServerException:

    An internal error has occurred.

UpdateSite

$result = $client->updateSite([/* ... */]);
$promise = $client->updateSiteAsync([/* ... */]);

Updates the site.

Parameter Syntax

$result = $client->updateSite([
    'Description' => '<string>',
    'Name' => '<string>',
    'Notes' => '<string>',
    'SiteId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Description
  • Type: string

The description of the site.

Name
  • Type: string

The name of the site.

Notes
  • Type: string

Notes about a site.

SiteId
  • Required: Yes
  • Type: string

The ID or the Amazon Resource Name (ARN) of the site.

In requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and sites throughout the Outposts Query API. To address backwards compatibility, the parameter names OutpostID or SiteID remain in use. Despite the parameter name, you can make the request with an ARN.

Result Syntax

[
    'Site' => [
        'AccountId' => '<string>',
        'Description' => '<string>',
        'Name' => '<string>',
        'Notes' => '<string>',
        'OperatingAddressCity' => '<string>',
        'OperatingAddressCountryCode' => '<string>',
        'OperatingAddressStateOrRegion' => '<string>',
        'RackPhysicalProperties' => [
            'FiberOpticCableType' => 'SINGLE_MODE|MULTI_MODE',
            'MaximumSupportedWeightLbs' => 'NO_LIMIT|MAX_1400_LBS|MAX_1600_LBS|MAX_1800_LBS|MAX_2000_LBS',
            'OpticalStandard' => 'OPTIC_10GBASE_SR|OPTIC_10GBASE_IR|OPTIC_10GBASE_LR|OPTIC_40GBASE_SR|OPTIC_40GBASE_ESR|OPTIC_40GBASE_IR4_LR4L|OPTIC_40GBASE_LR4|OPTIC_100GBASE_SR4|OPTIC_100GBASE_CWDM4|OPTIC_100GBASE_LR4|OPTIC_100G_PSM4_MSA|OPTIC_1000BASE_LX|OPTIC_1000BASE_SX',
            'PowerConnector' => 'L6_30P|IEC309|AH530P7W|AH532P6W',
            'PowerDrawKva' => 'POWER_5_KVA|POWER_10_KVA|POWER_15_KVA',
            'PowerFeedDrop' => 'ABOVE_RACK|BELOW_RACK',
            'PowerPhase' => 'SINGLE_PHASE|THREE_PHASE',
            'UplinkCount' => 'UPLINK_COUNT_1|UPLINK_COUNT_2|UPLINK_COUNT_3|UPLINK_COUNT_4|UPLINK_COUNT_5|UPLINK_COUNT_6|UPLINK_COUNT_7|UPLINK_COUNT_8|UPLINK_COUNT_12|UPLINK_COUNT_16',
            'UplinkGbps' => 'UPLINK_1G|UPLINK_10G|UPLINK_40G|UPLINK_100G',
        ],
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
Site
  • Type: Site structure

Information about a site.

Errors

  • ValidationException:

    A parameter is not valid.

  • ConflictException:

    Updating or deleting this resource can cause an inconsistent state.

  • NotFoundException:

    The specified request is not valid.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • InternalServerException:

    An internal error has occurred.

UpdateSiteAddress

$result = $client->updateSiteAddress([/* ... */]);
$promise = $client->updateSiteAddressAsync([/* ... */]);

Updates the site address.

To update a site address with an order IN_PROGRESS, you must wait for the order to complete or cancel the order.

You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.

Parameter Syntax

$result = $client->updateSiteAddress([
    'Address' => [ // REQUIRED
        'AddressLine1' => '<string>', // REQUIRED
        'AddressLine2' => '<string>',
        'AddressLine3' => '<string>',
        'City' => '<string>', // REQUIRED
        'ContactName' => '<string>',
        'ContactPhoneNumber' => '<string>',
        'CountryCode' => '<string>', // REQUIRED
        'DistrictOrCounty' => '<string>',
        'Municipality' => '<string>',
        'PostalCode' => '<string>', // REQUIRED
        'StateOrRegion' => '<string>', // REQUIRED
    ],
    'AddressType' => 'SHIPPING_ADDRESS|OPERATING_ADDRESS', // REQUIRED
    'SiteId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Address
  • Required: Yes
  • Type: Address structure

The address for the site.

AddressType
  • Required: Yes
  • Type: string

The type of the address.

SiteId
  • Required: Yes
  • Type: string

The ID or the Amazon Resource Name (ARN) of the site.

In requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and sites throughout the Outposts Query API. To address backwards compatibility, the parameter names OutpostID or SiteID remain in use. Despite the parameter name, you can make the request with an ARN.

Result Syntax

[
    'Address' => [
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'AddressLine3' => '<string>',
        'City' => '<string>',
        'ContactName' => '<string>',
        'ContactPhoneNumber' => '<string>',
        'CountryCode' => '<string>',
        'DistrictOrCounty' => '<string>',
        'Municipality' => '<string>',
        'PostalCode' => '<string>',
        'StateOrRegion' => '<string>',
    ],
    'AddressType' => 'SHIPPING_ADDRESS|OPERATING_ADDRESS',
]

Result Details

Members
Address
  • Type: Address structure

Information about an address.

AddressType
  • Type: string

The type of the address.

Errors

  • ValidationException:

    A parameter is not valid.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • NotFoundException:

    The specified request is not valid.

  • ConflictException:

    Updating or deleting this resource can cause an inconsistent state.

  • InternalServerException:

    An internal error has occurred.

UpdateSiteRackPhysicalProperties

$result = $client->updateSiteRackPhysicalProperties([/* ... */]);
$promise = $client->updateSiteRackPhysicalPropertiesAsync([/* ... */]);

Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.

To update a rack at a site with an order of IN_PROGRESS, you must wait for the order to complete or cancel the order.

Parameter Syntax

$result = $client->updateSiteRackPhysicalProperties([
    'FiberOpticCableType' => 'SINGLE_MODE|MULTI_MODE',
    'MaximumSupportedWeightLbs' => 'NO_LIMIT|MAX_1400_LBS|MAX_1600_LBS|MAX_1800_LBS|MAX_2000_LBS',
    'OpticalStandard' => 'OPTIC_10GBASE_SR|OPTIC_10GBASE_IR|OPTIC_10GBASE_LR|OPTIC_40GBASE_SR|OPTIC_40GBASE_ESR|OPTIC_40GBASE_IR4_LR4L|OPTIC_40GBASE_LR4|OPTIC_100GBASE_SR4|OPTIC_100GBASE_CWDM4|OPTIC_100GBASE_LR4|OPTIC_100G_PSM4_MSA|OPTIC_1000BASE_LX|OPTIC_1000BASE_SX',
    'PowerConnector' => 'L6_30P|IEC309|AH530P7W|AH532P6W',
    'PowerDrawKva' => 'POWER_5_KVA|POWER_10_KVA|POWER_15_KVA',
    'PowerFeedDrop' => 'ABOVE_RACK|BELOW_RACK',
    'PowerPhase' => 'SINGLE_PHASE|THREE_PHASE',
    'SiteId' => '<string>', // REQUIRED
    'UplinkCount' => 'UPLINK_COUNT_1|UPLINK_COUNT_2|UPLINK_COUNT_3|UPLINK_COUNT_4|UPLINK_COUNT_5|UPLINK_COUNT_6|UPLINK_COUNT_7|UPLINK_COUNT_8|UPLINK_COUNT_12|UPLINK_COUNT_16',
    'UplinkGbps' => 'UPLINK_1G|UPLINK_10G|UPLINK_40G|UPLINK_100G',
]);

Parameter Details

Members
FiberOpticCableType
  • Type: string

Specify the type of fiber that you will use to attach the Outpost to your network.

MaximumSupportedWeightLbs
  • Type: string

Specify the maximum rack weight that this site can support. NO_LIMIT is over 2000lbs.

OpticalStandard
  • Type: string

Specify the type of optical standard that you will use to attach the Outpost to your network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.

  • OPTIC_10GBASE_SR: 10GBASE-SR

  • OPTIC_10GBASE_IR: 10GBASE-IR

  • OPTIC_10GBASE_LR: 10GBASE-LR

  • OPTIC_40GBASE_SR: 40GBASE-SR

  • OPTIC_40GBASE_ESR: 40GBASE-ESR

  • OPTIC_40GBASE_IR4_LR4L: 40GBASE-IR (LR4L)

  • OPTIC_40GBASE_LR4: 40GBASE-LR4

  • OPTIC_100GBASE_SR4: 100GBASE-SR4

  • OPTIC_100GBASE_CWDM4: 100GBASE-CWDM4

  • OPTIC_100GBASE_LR4: 100GBASE-LR4

  • OPTIC_100G_PSM4_MSA: 100G PSM4 MSA

  • OPTIC_1000BASE_LX: 1000Base-LX

  • OPTIC_1000BASE_SX : 1000Base-SX

PowerConnector
  • Type: string

Specify the power connector that Amazon Web Services should plan to provide for connections to the hardware. Note the correlation between PowerPhase and PowerConnector.

  • Single-phase AC feed

    • L6-30P – (common in US); 30A; single phase

    • IEC309 (blue) – P+N+E, 6hr; 32 A; single phase

  • Three-phase AC feed

    • AH530P7W (red) – 3P+N+E, 7hr; 30A; three phase

    • AH532P6W (red) – 3P+N+E, 6hr; 32A; three phase

PowerDrawKva
  • Type: string

Specify in kVA the power draw available at the hardware placement position for the rack.

PowerFeedDrop
  • Type: string

Specify whether the power feed comes above or below the rack.

PowerPhase
  • Type: string

Specify the power option that you can provide for hardware.

  • Single-phase AC feed: 200 V to 277 V, 50 Hz or 60 Hz

  • Three-phase AC feed: 346 V to 480 V, 50 Hz or 60 Hz

SiteId
  • Required: Yes
  • Type: string

The ID or the Amazon Resource Name (ARN) of the site.

In requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and sites throughout the Outposts Query API. To address backwards compatibility, the parameter names OutpostID or SiteID remain in use. Despite the parameter name, you can make the request with an ARN.

UplinkCount
  • Type: string

Racks come with two Outpost network devices. Depending on the supported uplink speed at the site, the Outpost network devices provide a variable number of uplinks. Specify the number of uplinks for each Outpost network device that you intend to use to connect the rack to your network. Note the correlation between UplinkGbps and UplinkCount.

  • 1Gbps - Uplinks available: 1, 2, 4, 6, 8

  • 10Gbps - Uplinks available: 1, 2, 4, 8, 12, 16

  • 40 and 100 Gbps- Uplinks available: 1, 2, 4

UplinkGbps
  • Type: string

Specify the uplink speed the rack should support for the connection to the Region.

Result Syntax

[
    'Site' => [
        'AccountId' => '<string>',
        'Description' => '<string>',
        'Name' => '<string>',
        'Notes' => '<string>',
        'OperatingAddressCity' => '<string>',
        'OperatingAddressCountryCode' => '<string>',
        'OperatingAddressStateOrRegion' => '<string>',
        'RackPhysicalProperties' => [
            'FiberOpticCableType' => 'SINGLE_MODE|MULTI_MODE',
            'MaximumSupportedWeightLbs' => 'NO_LIMIT|MAX_1400_LBS|MAX_1600_LBS|MAX_1800_LBS|MAX_2000_LBS',
            'OpticalStandard' => 'OPTIC_10GBASE_SR|OPTIC_10GBASE_IR|OPTIC_10GBASE_LR|OPTIC_40GBASE_SR|OPTIC_40GBASE_ESR|OPTIC_40GBASE_IR4_LR4L|OPTIC_40GBASE_LR4|OPTIC_100GBASE_SR4|OPTIC_100GBASE_CWDM4|OPTIC_100GBASE_LR4|OPTIC_100G_PSM4_MSA|OPTIC_1000BASE_LX|OPTIC_1000BASE_SX',
            'PowerConnector' => 'L6_30P|IEC309|AH530P7W|AH532P6W',
            'PowerDrawKva' => 'POWER_5_KVA|POWER_10_KVA|POWER_15_KVA',
            'PowerFeedDrop' => 'ABOVE_RACK|BELOW_RACK',
            'PowerPhase' => 'SINGLE_PHASE|THREE_PHASE',
            'UplinkCount' => 'UPLINK_COUNT_1|UPLINK_COUNT_2|UPLINK_COUNT_3|UPLINK_COUNT_4|UPLINK_COUNT_5|UPLINK_COUNT_6|UPLINK_COUNT_7|UPLINK_COUNT_8|UPLINK_COUNT_12|UPLINK_COUNT_16',
            'UplinkGbps' => 'UPLINK_1G|UPLINK_10G|UPLINK_40G|UPLINK_100G',
        ],
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
Site
  • Type: Site structure

Information about a site.

Errors

  • ValidationException:

    A parameter is not valid.

  • ConflictException:

    Updating or deleting this resource can cause an inconsistent state.

  • NotFoundException:

    The specified request is not valid.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • InternalServerException:

    An internal error has occurred.

Shapes

AccessDeniedException

Description

You do not have permission to perform this operation.

Members
Message
  • Type: string

Address

Description

Information about an address.

Members
AddressLine1
  • Required: Yes
  • Type: string

The first line of the address.

AddressLine2
  • Type: string

The second line of the address.

AddressLine3
  • Type: string

The third line of the address.

City
  • Required: Yes
  • Type: string

The city for the address.

ContactName
  • Type: string

The name of the contact.

ContactPhoneNumber
  • Type: string

The phone number of the contact.

CountryCode
  • Required: Yes
  • Type: string

The ISO-3166 two-letter country code for the address.

DistrictOrCounty
  • Type: string

The district or county for the address.

Municipality
  • Type: string

The municipality for the address.

PostalCode
  • Required: Yes
  • Type: string

The postal code for the address.

StateOrRegion
  • Required: Yes
  • Type: string

The state for the address.

AssetInfo

Description

Information about hardware assets.

Members
AssetId
  • Type: string

The ID of the asset.

AssetLocation
  • Type: AssetLocation structure

The position of an asset in a rack.

AssetType
  • Type: string

The type of the asset.

ComputeAttributes
  • Type: ComputeAttributes structure

Information about compute hardware assets.

RackId
  • Type: string

The rack ID of the asset.

AssetLocation

Description

Information about the position of the asset in a rack.

Members
RackElevation
  • Type: float

The position of an asset in a rack measured in rack units.

CatalogItem

Description

Information about a catalog item.

Members
CatalogItemId
  • Type: string

The ID of the catalog item.

EC2Capacities
  • Type: Array of EC2Capacity structures

Information about the EC2 capacity of an item.

ItemStatus
  • Type: string

The status of a catalog item.

PowerKva
  • Type: float

Information about the power draw of an item.

SupportedStorage
  • Type: Array of strings

The supported storage options for the catalog item.

SupportedUplinkGbps
  • Type: Array of ints

The uplink speed this catalog item requires for the connection to the Region.

WeightLbs
  • Type: int

The weight of the item in pounds.

ComputeAttributes

Description

Information about compute hardware assets.

Members
HostId
  • Type: string

The host ID of any Dedicated Hosts on the asset.

ConflictException

Description

Updating or deleting this resource can cause an inconsistent state.

Members
Message
  • Type: string
ResourceId
  • Type: string

The ID of the resource causing the conflict.

ResourceType
  • Type: string

The type of the resource causing the conflict.

ConnectionDetails

Description

Information about a connection.

Members
AllowedIps
  • Type: Array of strings

The allowed IP addresses.

ClientPublicKey
  • Type: string

The public key of the client.

ClientTunnelAddress
  • Type: string

The client tunnel address.

ServerEndpoint
  • Type: string

The endpoint for the server.

ServerPublicKey
  • Type: string

The public key of the server.

ServerTunnelAddress
  • Type: string

The server tunnel address.

EC2Capacity

Description

Information about EC2 capacity.

Members
Family
  • Type: string

The family of the EC2 capacity.

MaxSize
  • Type: string

The maximum size of the EC2 capacity.

Quantity
  • Type: string

The quantity of the EC2 capacity.

InstanceTypeItem

Description

Information about an instance type.

Members
InstanceType
  • Type: string

The instance type.

InternalServerException

Description

An internal error has occurred.

Members
Message
  • Type: string

LineItem

Description

Information about a line item.

Members
CatalogItemId
  • Type: string

The ID of the catalog item.

LineItemId
  • Type: string

The ID of the line item.

Quantity
  • Type: int

The quantity of the line item.

Status
  • Type: string

The status of the line item.

LineItemRequest

Description

Information about a line item request.

Members
CatalogItemId
  • Type: string

The ID of the catalog item.

Quantity
  • Type: int

The quantity of a line item request.

NotFoundException

Description

The specified request is not valid.

Members
Message
  • Type: string

Order

Description

Information about an order.

Members
LineItems
  • Type: Array of LineItem structures

The line items for the order

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

The fulfillment date of the order.

OrderId
  • Type: string

The ID of the order.

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

The submission date for the order.

OutpostId
  • Type: string

The ID of the Outpost in the order.

PaymentOption
  • Type: string

The payment option for the order.

Status
  • Type: string

The status of the order.

  • PREPARING - Order is received and being prepared.

  • IN_PROGRESS - Order is either being built, shipped, or installed. To get more details, see the LineItem status.

  • COMPLETED - Order is complete.

  • CANCELLED - Order is cancelled.

  • ERROR - Customer should contact support.

The following status are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.

OrderSummary

Description

A summary of line items in your order.

Members
LineItemCountsByStatus
  • Type: Associative array of custom strings keys (LineItemStatus) to ints

The status of all line items in the order.

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

Fulfilment date for the order.

OrderId
  • Type: string

The ID of the order.

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

Submission date for the order.

OrderType
  • Type: string

The type of order.

OutpostId
  • Type: string

The ID of the Outpost.

Status
  • Type: string

The status of the order.

  • PREPARING - Order is received and is being prepared.

  • IN_PROGRESS - Order is either being built, shipped, or installed. For more information, see the LineItem status.

  • COMPLETED - Order is complete.

  • CANCELLED - Order is cancelled.

  • ERROR - Customer should contact support.

The following statuses are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.

Outpost

Description

Information about an Outpost.

Members
AvailabilityZone
  • Type: string

The Availability Zone.

AvailabilityZoneId
  • Type: string

The ID of the Availability Zone.

Description
  • Type: string

The description of the Outpost.

LifeCycleStatus
  • Type: string

The life cycle status.

Name
  • Type: string

The name of the Outpost.

OutpostArn
  • Type: string

The Amazon Resource Name (ARN) of the Outpost.

OutpostId
  • Type: string

The ID of the Outpost.

OwnerId
  • Type: string

The Amazon Web Services account ID of the Outpost owner.

SiteArn
  • Type: string

The Amazon Resource Name (ARN) of the site.

SiteId
  • Type: string

The ID of the site.

SupportedHardwareType
  • Type: string

The hardware type.

Tags
  • Type: Associative array of custom strings keys (TagKey) to strings

The Outpost tags.

RackPhysicalProperties

Description

Information about the physical and logistical details for racks at sites. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.

Members
FiberOpticCableType
  • Type: string

The type of fiber used to attach the Outpost to the network.

MaximumSupportedWeightLbs
  • Type: string

The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg).

OpticalStandard
  • Type: string

The type of optical standard used to attach the Outpost to the network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.

PowerConnector
  • Type: string

The power connector for the hardware.

PowerDrawKva
  • Type: string

The power draw available at the hardware placement position for the rack.

PowerFeedDrop
  • Type: string

The position of the power feed.

PowerPhase
  • Type: string

The power option that you can provide for hardware.

UplinkCount
  • Type: string

The number of uplinks each Outpost network device.

UplinkGbps
  • Type: string

The uplink speed the rack supports for the connection to the Region.

ServiceQuotaExceededException

Description

You have exceeded a service quota.

Members
Message
  • Type: string

Site

Description

Information about a site.

Members
AccountId
  • Type: string

The ID of the Amazon Web Services account.

Description
  • Type: string

The description of the site.

Name
  • Type: string

The name of the site.

Notes
  • Type: string

Notes about a site.

OperatingAddressCity
  • Type: string

City where the hardware is installed and powered on.

OperatingAddressCountryCode
  • Type: string

The ISO-3166 two-letter country code where the hardware is installed and powered on.

OperatingAddressStateOrRegion
  • Type: string

State or region where the hardware is installed and powered on.

RackPhysicalProperties
  • Type: RackPhysicalProperties structure

Information about the physical and logistical details for a rack at the site.

SiteArn
  • Type: string

The Amazon Resource Name (ARN) of the site.

SiteId
  • Type: string

The ID of the site.

Tags
  • Type: Associative array of custom strings keys (TagKey) to strings

The site tags.

ValidationException

Description

A parameter is not valid.

Members
Message
  • Type: string
AWS SDK for PHP 3.x API documentation generated by ApiGen