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

Amazon OpenSearch Service 2021-01-01

Client: Aws\OpenSearchService\OpenSearchServiceClient
Service ID: opensearch
Version: 2021-01-01

This page describes the parameters and results for the operations of the Amazon OpenSearch Service (2021-01-01), and shows how to use the Aws\OpenSearchService\OpenSearchServiceClient object to call the described operations. This documentation is specific to the 2021-01-01 API version of the service.

Operation Summary

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

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

  • AcceptInboundConnection ( array $params = [] )

    Allows the remote domain owner to accept an inbound cross-cluster connection request.

  • AddTags ( array $params = [] )

    Attaches tags to an existing domain.

  • AssociatePackage ( array $params = [] )

    Associates a package with an Amazon OpenSearch Service domain.

  • CancelServiceSoftwareUpdate ( array $params = [] )

    Cancels a scheduled service software update for an Amazon OpenSearch Service domain.

  • CreateDomain ( array $params = [] )

    Creates a new Amazon OpenSearch Service domain.

  • CreateOutboundConnection ( array $params = [] )

    Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.

  • CreatePackage ( array $params = [] )

    Create a package for use with Amazon OpenSearch Service domains.

  • DeleteDomain ( array $params = [] )

    Permanently deletes the specified domain and all of its data.

  • DeleteInboundConnection ( array $params = [] )

    Allows the remote domain owner to delete an existing inbound cross-cluster connection.

  • DeleteOutboundConnection ( array $params = [] )

    Allows the local domain owner to delete an existing outbound cross-cluster connection.

  • DeletePackage ( array $params = [] )

    Deletes the package.

  • DescribeDomain ( array $params = [] )

    Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.

  • DescribeDomainAutoTunes ( array $params = [] )

    Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.

  • DescribeDomainChangeProgress ( array $params = [] )

    Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.

  • DescribeDomainConfig ( array $params = [] )

    Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.

  • DescribeDomains ( array $params = [] )

    Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.

  • DescribeInboundConnections ( array $params = [] )

    Lists all the inbound cross-cluster connections for a remote domain.

  • DescribeInstanceTypeLimits ( array $params = [] )

    Describe the limits for a given instance type and OpenSearch or Elasticsearch version.

  • DescribeOutboundConnections ( array $params = [] )

    Lists all the outbound cross-cluster connections for a local domain.

  • DescribePackages ( array $params = [] )

    Describes all packages available to Amazon OpenSearch Service domains.

  • DescribeReservedInstanceOfferings ( array $params = [] )

    Lists available reserved OpenSearch instance offerings.

  • DescribeReservedInstances ( array $params = [] )

    Returns information about reserved OpenSearch instances for this account.

  • DissociatePackage ( array $params = [] )

    Dissociates a package from the Amazon OpenSearch Service domain.

  • GetCompatibleVersions ( array $params = [] )

    Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch.

  • GetPackageVersionHistory ( array $params = [] )

    Returns a list of package versions, along with their creation time and commit message.

  • GetUpgradeHistory ( array $params = [] )

    Retrieves the complete history of the last 10 upgrades performed on the domain.

  • GetUpgradeStatus ( array $params = [] )

    Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.

  • ListDomainNames ( array $params = [] )

    Returns the names of all domains owned by the current user's account.

  • ListDomainsForPackage ( array $params = [] )

    Lists all Amazon OpenSearch Service domains associated with the package.

  • ListInstanceTypeDetails ( array $params = [] )
  • ListPackagesForDomain ( array $params = [] )

    Lists all packages associated with the Amazon OpenSearch Service domain.

  • ListTags ( array $params = [] )

    Returns all tags for the given domain.

  • ListVersions ( array $params = [] )

    List all supported versions of OpenSearch and Elasticsearch.

  • PurchaseReservedInstanceOffering ( array $params = [] )

    Allows you to purchase reserved OpenSearch instances.

  • RejectInboundConnection ( array $params = [] )

    Allows the remote domain owner to reject an inbound cross-cluster connection request.

  • RemoveTags ( array $params = [] )

    Removes the specified set of tags from the given domain.

  • StartServiceSoftwareUpdate ( array $params = [] )

    Schedules a service software update for an Amazon OpenSearch Service domain.

  • UpdateDomainConfig ( array $params = [] )

    Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.

  • UpdatePackage ( array $params = [] )

    Updates a package for use with Amazon OpenSearch Service domains.

  • UpgradeDomain ( array $params = [] )

    Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

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:

  • DescribeDomainAutoTunes
  • DescribeInboundConnections
  • DescribeOutboundConnections
  • DescribePackages
  • DescribeReservedInstanceOfferings
  • DescribeReservedInstances
  • GetPackageVersionHistory
  • GetUpgradeHistory
  • ListDomainsForPackage
  • ListInstanceTypeDetails
  • ListPackagesForDomain
  • ListVersions

Operations

AcceptInboundConnection

$result = $client->acceptInboundConnection([/* ... */]);
$promise = $client->acceptInboundConnectionAsync([/* ... */]);

Allows the remote domain owner to accept an inbound cross-cluster connection request.

Parameter Syntax

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

Parameter Details

Members
ConnectionId
  • Required: Yes
  • Type: string

The ID of the inbound connection you want to accept.

Result Syntax

[
    'Connection' => [
        'ConnectionId' => '<string>',
        'ConnectionStatus' => [
            'Message' => '<string>',
            'StatusCode' => 'PENDING_ACCEPTANCE|APPROVED|PROVISIONING|ACTIVE|REJECTING|REJECTED|DELETING|DELETED',
        ],
        'LocalDomainInfo' => [
            'AWSDomainInformation' => [
                'DomainName' => '<string>',
                'OwnerId' => '<string>',
                'Region' => '<string>',
            ],
        ],
        'RemoteDomainInfo' => [
            'AWSDomainInformation' => [
                'DomainName' => '<string>',
                'OwnerId' => '<string>',
                'Region' => '<string>',
            ],
        ],
    ],
]

Result Details

Members
Connection
  • Type: InboundConnection structure

The InboundConnection of the accepted inbound connection.

Errors

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • LimitExceededException:

    An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

  • DisabledOperationException:

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

AddTags

$result = $client->addTags([/* ... */]);
$promise = $client->addTagsAsync([/* ... */]);

Attaches tags to an existing domain. Tags are a set of case-sensitive key value pairs. An domain can have up to 10 tags. See Tagging Amazon OpenSearch Service domains for more information.

Parameter Syntax

$result = $client->addTags([
    'ARN' => '<string>', // REQUIRED
    'TagList' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ARN
  • Required: Yes
  • Type: string

Specify the ARN of the domain you want to add tags to.

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

List of Tag to add to the domain.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • BaseException:

    An error occurred while processing the request.

  • LimitExceededException:

    An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

AssociatePackage

$result = $client->associatePackage([/* ... */]);
$promise = $client->associatePackageAsync([/* ... */]);

Associates a package with an Amazon OpenSearch Service domain.

Parameter Syntax

$result = $client->associatePackage([
    'DomainName' => '<string>', // REQUIRED
    'PackageID' => '<string>', // REQUIRED
]);

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The name of the domain to associate the package with.

PackageID
  • Required: Yes
  • Type: string

Internal ID of the package to associate with a domain. Use DescribePackages to find this value.

Result Syntax

[
    'DomainPackageDetails' => [
        'DomainName' => '<string>',
        'DomainPackageStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ACTIVE|DISSOCIATING|DISSOCIATION_FAILED',
        'ErrorDetails' => [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        'LastUpdated' => <DateTime>,
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageType' => 'TXT-DICTIONARY',
        'PackageVersion' => '<string>',
        'ReferencePath' => '<string>',
    ],
]

Result Details

Members
DomainPackageDetails
  • Type: DomainPackageDetails structure

DomainPackageDetails

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • AccessDeniedException:

    An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

  • ConflictException:

    An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

CancelServiceSoftwareUpdate

$result = $client->cancelServiceSoftwareUpdate([/* ... */]);
$promise = $client->cancelServiceSoftwareUpdateAsync([/* ... */]);

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

Parameter Syntax

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

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The name of the domain that you want to stop the latest service software update on.

Result Syntax

[
    'ServiceSoftwareOptions' => [
        'AutomatedUpdateDate' => <DateTime>,
        'Cancellable' => true || false,
        'CurrentVersion' => '<string>',
        'Description' => '<string>',
        'NewVersion' => '<string>',
        'OptionalDeployment' => true || false,
        'UpdateAvailable' => true || false,
        'UpdateStatus' => 'PENDING_UPDATE|IN_PROGRESS|COMPLETED|NOT_ELIGIBLE|ELIGIBLE',
    ],
]

Result Details

Members
ServiceSoftwareOptions
  • Type: ServiceSoftwareOptions structure

The current status of the OpenSearch service software update.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

CreateDomain

$result = $client->createDomain([/* ... */]);
$promise = $client->createDomainAsync([/* ... */]);

Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide.

Parameter Syntax

$result = $client->createDomain([
    'AccessPolicies' => '<string>',
    'AdvancedOptions' => ['<string>', ...],
    'AdvancedSecurityOptions' => [
        'AnonymousAuthEnabled' => true || false,
        'Enabled' => true || false,
        'InternalUserDatabaseEnabled' => true || false,
        'MasterUserOptions' => [
            'MasterUserARN' => '<string>',
            'MasterUserName' => '<string>',
            'MasterUserPassword' => '<string>',
        ],
        'SAMLOptions' => [
            'Enabled' => true || false,
            'Idp' => [
                'EntityId' => '<string>', // REQUIRED
                'MetadataContent' => '<string>', // REQUIRED
            ],
            'MasterBackendRole' => '<string>',
            'MasterUserName' => '<string>',
            'RolesKey' => '<string>',
            'SessionTimeoutMinutes' => <integer>,
            'SubjectKey' => '<string>',
        ],
    ],
    'AutoTuneOptions' => [
        'DesiredState' => 'ENABLED|DISABLED',
        'MaintenanceSchedules' => [
            [
                'CronExpressionForRecurrence' => '<string>',
                'Duration' => [
                    'Unit' => 'HOURS',
                    'Value' => <integer>,
                ],
                'StartAt' => <integer || string || DateTime>,
            ],
            // ...
        ],
    ],
    'ClusterConfig' => [
        'ColdStorageOptions' => [
            'Enabled' => true || false, // REQUIRED
        ],
        'DedicatedMasterCount' => <integer>,
        'DedicatedMasterEnabled' => true || false,
        'DedicatedMasterType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
        'InstanceCount' => <integer>,
        'InstanceType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
        'WarmCount' => <integer>,
        'WarmEnabled' => true || false,
        'WarmType' => 'ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search',
        'ZoneAwarenessConfig' => [
            'AvailabilityZoneCount' => <integer>,
        ],
        'ZoneAwarenessEnabled' => true || false,
    ],
    'CognitoOptions' => [
        'Enabled' => true || false,
        'IdentityPoolId' => '<string>',
        'RoleArn' => '<string>',
        'UserPoolId' => '<string>',
    ],
    'DomainEndpointOptions' => [
        'CustomEndpoint' => '<string>',
        'CustomEndpointCertificateArn' => '<string>',
        'CustomEndpointEnabled' => true || false,
        'EnforceHTTPS' => true || false,
        'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
    ],
    'DomainName' => '<string>', // REQUIRED
    'EBSOptions' => [
        'EBSEnabled' => true || false,
        'Iops' => <integer>,
        'VolumeSize' => <integer>,
        'VolumeType' => 'standard|gp2|io1',
    ],
    'EncryptionAtRestOptions' => [
        'Enabled' => true || false,
        'KmsKeyId' => '<string>',
    ],
    'EngineVersion' => '<string>',
    'LogPublishingOptions' => [
        '<LogType>' => [
            'CloudWatchLogsLogGroupArn' => '<string>',
            'Enabled' => true || false,
        ],
        // ...
    ],
    'NodeToNodeEncryptionOptions' => [
        'Enabled' => true || false,
    ],
    'SnapshotOptions' => [
        'AutomatedSnapshotStartHour' => <integer>,
    ],
    'TagList' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VPCOptions' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Members
AccessPolicies
  • Type: string

IAM access policy as a JSON-formatted string.

AdvancedOptions
  • Type: Associative array of custom strings keys (String) to strings

Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.

AdvancedSecurityOptions
  • Type: AdvancedSecurityOptionsInput structure

Specifies advanced security options.

AutoTuneOptions
  • Type: AutoTuneOptionsInput structure

Specifies Auto-Tune options.

ClusterConfig
  • Type: ClusterConfig structure

Configuration options for a domain. Specifies the instance type and number of instances in the domain.

CognitoOptions
  • Type: CognitoOptions structure

Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

DomainEndpointOptions
  • Type: DomainEndpointOptions structure

Options to specify configurations that will be applied to the domain endpoint.

DomainName
  • Required: Yes
  • Type: string

The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

EBSOptions
  • Type: EBSOptions structure

Options to enable, disable, and specify the type and size of EBS storage volumes.

EncryptionAtRestOptions
  • Type: EncryptionAtRestOptions structure

Options for encryption of data at rest.

EngineVersion
  • Type: string

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, "OpenSearch_1.0" or "Elasticsearch_7.9". For more information, see Creating and managing Amazon OpenSearch Service domains .

LogPublishingOptions
  • Type: Associative array of custom strings keys (LogType) to LogPublishingOption structures

Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.

NodeToNodeEncryptionOptions
  • Type: NodeToNodeEncryptionOptions structure

Node-to-node encryption options.

SnapshotOptions
  • Type: SnapshotOptions structure

Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

TagList
  • Type: Array of Tag structures

A list of Tag added during domain creation.

VPCOptions
  • Type: VPCOptions structure

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

Result Syntax

[
    'DomainStatus' => [
        'ARN' => '<string>',
        'AccessPolicies' => '<string>',
        'AdvancedOptions' => ['<string>', ...],
        'AdvancedSecurityOptions' => [
            'AnonymousAuthDisableDate' => <DateTime>,
            'AnonymousAuthEnabled' => true || false,
            'Enabled' => true || false,
            'InternalUserDatabaseEnabled' => true || false,
            'SAMLOptions' => [
                'Enabled' => true || false,
                'Idp' => [
                    'EntityId' => '<string>',
                    'MetadataContent' => '<string>',
                ],
                'RolesKey' => '<string>',
                'SessionTimeoutMinutes' => <integer>,
                'SubjectKey' => '<string>',
            ],
        ],
        'AutoTuneOptions' => [
            'ErrorMessage' => '<string>',
            'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
        ],
        'ChangeProgressDetails' => [
            'ChangeId' => '<string>',
            'Message' => '<string>',
        ],
        'ClusterConfig' => [
            'ColdStorageOptions' => [
                'Enabled' => true || false,
            ],
            'DedicatedMasterCount' => <integer>,
            'DedicatedMasterEnabled' => true || false,
            'DedicatedMasterType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
            'InstanceCount' => <integer>,
            'InstanceType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
            'WarmCount' => <integer>,
            'WarmEnabled' => true || false,
            'WarmType' => 'ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search',
            'ZoneAwarenessConfig' => [
                'AvailabilityZoneCount' => <integer>,
            ],
            'ZoneAwarenessEnabled' => true || false,
        ],
        'CognitoOptions' => [
            'Enabled' => true || false,
            'IdentityPoolId' => '<string>',
            'RoleArn' => '<string>',
            'UserPoolId' => '<string>',
        ],
        'Created' => true || false,
        'Deleted' => true || false,
        'DomainEndpointOptions' => [
            'CustomEndpoint' => '<string>',
            'CustomEndpointCertificateArn' => '<string>',
            'CustomEndpointEnabled' => true || false,
            'EnforceHTTPS' => true || false,
            'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
        ],
        'DomainId' => '<string>',
        'DomainName' => '<string>',
        'EBSOptions' => [
            'EBSEnabled' => true || false,
            'Iops' => <integer>,
            'VolumeSize' => <integer>,
            'VolumeType' => 'standard|gp2|io1',
        ],
        'EncryptionAtRestOptions' => [
            'Enabled' => true || false,
            'KmsKeyId' => '<string>',
        ],
        'Endpoint' => '<string>',
        'Endpoints' => ['<string>', ...],
        'EngineVersion' => '<string>',
        'LogPublishingOptions' => [
            '<LogType>' => [
                'CloudWatchLogsLogGroupArn' => '<string>',
                'Enabled' => true || false,
            ],
            // ...
        ],
        'NodeToNodeEncryptionOptions' => [
            'Enabled' => true || false,
        ],
        'Processing' => true || false,
        'ServiceSoftwareOptions' => [
            'AutomatedUpdateDate' => <DateTime>,
            'Cancellable' => true || false,
            'CurrentVersion' => '<string>',
            'Description' => '<string>',
            'NewVersion' => '<string>',
            'OptionalDeployment' => true || false,
            'UpdateAvailable' => true || false,
            'UpdateStatus' => 'PENDING_UPDATE|IN_PROGRESS|COMPLETED|NOT_ELIGIBLE|ELIGIBLE',
        ],
        'SnapshotOptions' => [
            'AutomatedSnapshotStartHour' => <integer>,
        ],
        'UpgradeProcessing' => true || false,
        'VPCOptions' => [
            'AvailabilityZones' => ['<string>', ...],
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VPCId' => '<string>',
        ],
    ],
]

Result Details

Members
DomainStatus
  • Type: DomainStatus structure

The status of the newly created domain.

Errors

  • BaseException:

    An error occurred while processing the request.

  • DisabledOperationException:

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • InvalidTypeException:

    An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

  • LimitExceededException:

    An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

  • ResourceAlreadyExistsException:

    An exception for creating a resource that already exists. Gives http status code of 400.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

CreateOutboundConnection

$result = $client->createOutboundConnection([/* ... */]);
$promise = $client->createOutboundConnectionAsync([/* ... */]);

Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.

Parameter Syntax

$result = $client->createOutboundConnection([
    'ConnectionAlias' => '<string>', // REQUIRED
    'LocalDomainInfo' => [ // REQUIRED
        'AWSDomainInformation' => [
            'DomainName' => '<string>', // REQUIRED
            'OwnerId' => '<string>',
            'Region' => '<string>',
        ],
    ],
    'RemoteDomainInfo' => [ // REQUIRED
        'AWSDomainInformation' => [
            'DomainName' => '<string>', // REQUIRED
            'OwnerId' => '<string>',
            'Region' => '<string>',
        ],
    ],
]);

Parameter Details

Members
ConnectionAlias
  • Required: Yes
  • Type: string

The connection alias used used by the customer for this cross-cluster connection.

LocalDomainInfo
  • Required: Yes
  • Type: DomainInformationContainer structure

The AWSDomainInformation for the local OpenSearch domain.

RemoteDomainInfo
  • Required: Yes
  • Type: DomainInformationContainer structure

The AWSDomainInformation for the remote OpenSearch domain.

Result Syntax

[
    'ConnectionAlias' => '<string>',
    'ConnectionId' => '<string>',
    'ConnectionStatus' => [
        'Message' => '<string>',
        'StatusCode' => 'VALIDATING|VALIDATION_FAILED|PENDING_ACCEPTANCE|APPROVED|PROVISIONING|ACTIVE|REJECTING|REJECTED|DELETING|DELETED',
    ],
    'LocalDomainInfo' => [
        'AWSDomainInformation' => [
            'DomainName' => '<string>',
            'OwnerId' => '<string>',
            'Region' => '<string>',
        ],
    ],
    'RemoteDomainInfo' => [
        'AWSDomainInformation' => [
            'DomainName' => '<string>',
            'OwnerId' => '<string>',
            'Region' => '<string>',
        ],
    ],
]

Result Details

Members
ConnectionAlias
  • Type: string

The connection alias provided during the create connection request.

ConnectionId
  • Type: string

The unique ID for the created outbound connection, which is used for subsequent operations on the connection.

ConnectionStatus
  • Type: OutboundConnectionStatus structure

The OutboundConnectionStatus for the newly created connection.

LocalDomainInfo
  • Type: DomainInformationContainer structure

The AWSDomainInformation for the local OpenSearch domain.

RemoteDomainInfo
  • Type: DomainInformationContainer structure

The AWSDomainInformation for the remote OpenSearch domain.

Errors

  • LimitExceededException:

    An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceAlreadyExistsException:

    An exception for creating a resource that already exists. Gives http status code of 400.

  • DisabledOperationException:

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

CreatePackage

$result = $client->createPackage([/* ... */]);
$promise = $client->createPackageAsync([/* ... */]);

Create a package for use with Amazon OpenSearch Service domains.

Parameter Syntax

$result = $client->createPackage([
    'PackageDescription' => '<string>',
    'PackageName' => '<string>', // REQUIRED
    'PackageSource' => [ // REQUIRED
        'S3BucketName' => '<string>',
        'S3Key' => '<string>',
    ],
    'PackageType' => 'TXT-DICTIONARY', // REQUIRED
]);

Parameter Details

Members
PackageDescription
  • Type: string

Description of the package.

PackageName
  • Required: Yes
  • Type: string

Unique identifier for the package.

PackageSource
  • Required: Yes
  • Type: PackageSource structure

The Amazon S3 location from which to import the package.

PackageType
  • Required: Yes
  • Type: string

Type of package. Currently supports only TXT-DICTIONARY.

Result Syntax

[
    'PackageDetails' => [
        'AvailablePackageVersion' => '<string>',
        'CreatedAt' => <DateTime>,
        'ErrorDetails' => [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        'LastUpdatedAt' => <DateTime>,
        'PackageDescription' => '<string>',
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageStatus' => 'COPYING|COPY_FAILED|VALIDATING|VALIDATION_FAILED|AVAILABLE|DELETING|DELETED|DELETE_FAILED',
        'PackageType' => 'TXT-DICTIONARY',
    ],
]

Result Details

Members
PackageDetails
  • Type: PackageDetails structure

Information about the package.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • LimitExceededException:

    An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

  • InvalidTypeException:

    An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

  • ResourceAlreadyExistsException:

    An exception for creating a resource that already exists. Gives http status code of 400.

  • AccessDeniedException:

    An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

DeleteDomain

$result = $client->deleteDomain([/* ... */]);
$promise = $client->deleteDomainAsync([/* ... */]);

Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered.

Parameter Syntax

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

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The name of the domain you want to permanently delete.

Result Syntax

[
    'DomainStatus' => [
        'ARN' => '<string>',
        'AccessPolicies' => '<string>',
        'AdvancedOptions' => ['<string>', ...],
        'AdvancedSecurityOptions' => [
            'AnonymousAuthDisableDate' => <DateTime>,
            'AnonymousAuthEnabled' => true || false,
            'Enabled' => true || false,
            'InternalUserDatabaseEnabled' => true || false,
            'SAMLOptions' => [
                'Enabled' => true || false,
                'Idp' => [
                    'EntityId' => '<string>',
                    'MetadataContent' => '<string>',
                ],
                'RolesKey' => '<string>',
                'SessionTimeoutMinutes' => <integer>,
                'SubjectKey' => '<string>',
            ],
        ],
        'AutoTuneOptions' => [
            'ErrorMessage' => '<string>',
            'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
        ],
        'ChangeProgressDetails' => [
            'ChangeId' => '<string>',
            'Message' => '<string>',
        ],
        'ClusterConfig' => [
            'ColdStorageOptions' => [
                'Enabled' => true || false,
            ],
            'DedicatedMasterCount' => <integer>,
            'DedicatedMasterEnabled' => true || false,
            'DedicatedMasterType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
            'InstanceCount' => <integer>,
            'InstanceType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
            'WarmCount' => <integer>,
            'WarmEnabled' => true || false,
            'WarmType' => 'ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search',
            'ZoneAwarenessConfig' => [
                'AvailabilityZoneCount' => <integer>,
            ],
            'ZoneAwarenessEnabled' => true || false,
        ],
        'CognitoOptions' => [
            'Enabled' => true || false,
            'IdentityPoolId' => '<string>',
            'RoleArn' => '<string>',
            'UserPoolId' => '<string>',
        ],
        'Created' => true || false,
        'Deleted' => true || false,
        'DomainEndpointOptions' => [
            'CustomEndpoint' => '<string>',
            'CustomEndpointCertificateArn' => '<string>',
            'CustomEndpointEnabled' => true || false,
            'EnforceHTTPS' => true || false,
            'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
        ],
        'DomainId' => '<string>',
        'DomainName' => '<string>',
        'EBSOptions' => [
            'EBSEnabled' => true || false,
            'Iops' => <integer>,
            'VolumeSize' => <integer>,
            'VolumeType' => 'standard|gp2|io1',
        ],
        'EncryptionAtRestOptions' => [
            'Enabled' => true || false,
            'KmsKeyId' => '<string>',
        ],
        'Endpoint' => '<string>',
        'Endpoints' => ['<string>', ...],
        'EngineVersion' => '<string>',
        'LogPublishingOptions' => [
            '<LogType>' => [
                'CloudWatchLogsLogGroupArn' => '<string>',
                'Enabled' => true || false,
            ],
            // ...
        ],
        'NodeToNodeEncryptionOptions' => [
            'Enabled' => true || false,
        ],
        'Processing' => true || false,
        'ServiceSoftwareOptions' => [
            'AutomatedUpdateDate' => <DateTime>,
            'Cancellable' => true || false,
            'CurrentVersion' => '<string>',
            'Description' => '<string>',
            'NewVersion' => '<string>',
            'OptionalDeployment' => true || false,
            'UpdateAvailable' => true || false,
            'UpdateStatus' => 'PENDING_UPDATE|IN_PROGRESS|COMPLETED|NOT_ELIGIBLE|ELIGIBLE',
        ],
        'SnapshotOptions' => [
            'AutomatedSnapshotStartHour' => <integer>,
        ],
        'UpgradeProcessing' => true || false,
        'VPCOptions' => [
            'AvailabilityZones' => ['<string>', ...],
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VPCId' => '<string>',
        ],
    ],
]

Result Details

Members
DomainStatus
  • Type: DomainStatus structure

The status of the domain being deleted.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

DeleteInboundConnection

$result = $client->deleteInboundConnection([/* ... */]);
$promise = $client->deleteInboundConnectionAsync([/* ... */]);

Allows the remote domain owner to delete an existing inbound cross-cluster connection.

Parameter Syntax

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

Parameter Details

Members
ConnectionId
  • Required: Yes
  • Type: string

The ID of the inbound connection to permanently delete.

Result Syntax

[
    'Connection' => [
        'ConnectionId' => '<string>',
        'ConnectionStatus' => [
            'Message' => '<string>',
            'StatusCode' => 'PENDING_ACCEPTANCE|APPROVED|PROVISIONING|ACTIVE|REJECTING|REJECTED|DELETING|DELETED',
        ],
        'LocalDomainInfo' => [
            'AWSDomainInformation' => [
                'DomainName' => '<string>',
                'OwnerId' => '<string>',
                'Region' => '<string>',
            ],
        ],
        'RemoteDomainInfo' => [
            'AWSDomainInformation' => [
                'DomainName' => '<string>',
                'OwnerId' => '<string>',
                'Region' => '<string>',
            ],
        ],
    ],
]

Result Details

Members
Connection
  • Type: InboundConnection structure

The InboundConnection of the deleted inbound connection.

Errors

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • DisabledOperationException:

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

DeleteOutboundConnection

$result = $client->deleteOutboundConnection([/* ... */]);
$promise = $client->deleteOutboundConnectionAsync([/* ... */]);

Allows the local domain owner to delete an existing outbound cross-cluster connection.

Parameter Syntax

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

Parameter Details

Members
ConnectionId
  • Required: Yes
  • Type: string

The ID of the outbound connection you want to permanently delete.

Result Syntax

[
    'Connection' => [
        'ConnectionAlias' => '<string>',
        'ConnectionId' => '<string>',
        'ConnectionStatus' => [
            'Message' => '<string>',
            'StatusCode' => 'VALIDATING|VALIDATION_FAILED|PENDING_ACCEPTANCE|APPROVED|PROVISIONING|ACTIVE|REJECTING|REJECTED|DELETING|DELETED',
        ],
        'LocalDomainInfo' => [
            'AWSDomainInformation' => [
                'DomainName' => '<string>',
                'OwnerId' => '<string>',
                'Region' => '<string>',
            ],
        ],
        'RemoteDomainInfo' => [
            'AWSDomainInformation' => [
                'DomainName' => '<string>',
                'OwnerId' => '<string>',
                'Region' => '<string>',
            ],
        ],
    ],
]

Result Details

Members
Connection
  • Type: OutboundConnection structure

The OutboundConnection of the deleted outbound connection.

Errors

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • DisabledOperationException:

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

DeletePackage

$result = $client->deletePackage([/* ... */]);
$promise = $client->deletePackageAsync([/* ... */]);

Deletes the package.

Parameter Syntax

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

Parameter Details

Members
PackageID
  • Required: Yes
  • Type: string

The internal ID of the package you want to delete. Use DescribePackages to find this value.

Result Syntax

[
    'PackageDetails' => [
        'AvailablePackageVersion' => '<string>',
        'CreatedAt' => <DateTime>,
        'ErrorDetails' => [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        'LastUpdatedAt' => <DateTime>,
        'PackageDescription' => '<string>',
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageStatus' => 'COPYING|COPY_FAILED|VALIDATING|VALIDATION_FAILED|AVAILABLE|DELETING|DELETED|DELETE_FAILED',
        'PackageType' => 'TXT-DICTIONARY',
    ],
]

Result Details

Members
PackageDetails
  • Type: PackageDetails structure

PackageDetails

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • AccessDeniedException:

    An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

  • ConflictException:

    An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

DescribeDomain

$result = $client->describeDomain([/* ... */]);
$promise = $client->describeDomainAsync([/* ... */]);

Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.

Parameter Syntax

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

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The name of the domain for which you want information.

Result Syntax

[
    'DomainStatus' => [
        'ARN' => '<string>',
        'AccessPolicies' => '<string>',
        'AdvancedOptions' => ['<string>', ...],
        'AdvancedSecurityOptions' => [
            'AnonymousAuthDisableDate' => <DateTime>,
            'AnonymousAuthEnabled' => true || false,
            'Enabled' => true || false,
            'InternalUserDatabaseEnabled' => true || false,
            'SAMLOptions' => [
                'Enabled' => true || false,
                'Idp' => [
                    'EntityId' => '<string>',
                    'MetadataContent' => '<string>',
                ],
                'RolesKey' => '<string>',
                'SessionTimeoutMinutes' => <integer>,
                'SubjectKey' => '<string>',
            ],
        ],
        'AutoTuneOptions' => [
            'ErrorMessage' => '<string>',
            'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
        ],
        'ChangeProgressDetails' => [
            'ChangeId' => '<string>',
            'Message' => '<string>',
        ],
        'ClusterConfig' => [
            'ColdStorageOptions' => [
                'Enabled' => true || false,
            ],
            'DedicatedMasterCount' => <integer>,
            'DedicatedMasterEnabled' => true || false,
            'DedicatedMasterType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
            'InstanceCount' => <integer>,
            'InstanceType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
            'WarmCount' => <integer>,
            'WarmEnabled' => true || false,
            'WarmType' => 'ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search',
            'ZoneAwarenessConfig' => [
                'AvailabilityZoneCount' => <integer>,
            ],
            'ZoneAwarenessEnabled' => true || false,
        ],
        'CognitoOptions' => [
            'Enabled' => true || false,
            'IdentityPoolId' => '<string>',
            'RoleArn' => '<string>',
            'UserPoolId' => '<string>',
        ],
        'Created' => true || false,
        'Deleted' => true || false,
        'DomainEndpointOptions' => [
            'CustomEndpoint' => '<string>',
            'CustomEndpointCertificateArn' => '<string>',
            'CustomEndpointEnabled' => true || false,
            'EnforceHTTPS' => true || false,
            'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
        ],
        'DomainId' => '<string>',
        'DomainName' => '<string>',
        'EBSOptions' => [
            'EBSEnabled' => true || false,
            'Iops' => <integer>,
            'VolumeSize' => <integer>,
            'VolumeType' => 'standard|gp2|io1',
        ],
        'EncryptionAtRestOptions' => [
            'Enabled' => true || false,
            'KmsKeyId' => '<string>',
        ],
        'Endpoint' => '<string>',
        'Endpoints' => ['<string>', ...],
        'EngineVersion' => '<string>',
        'LogPublishingOptions' => [
            '<LogType>' => [
                'CloudWatchLogsLogGroupArn' => '<string>',
                'Enabled' => true || false,
            ],
            // ...
        ],
        'NodeToNodeEncryptionOptions' => [
            'Enabled' => true || false,
        ],
        'Processing' => true || false,
        'ServiceSoftwareOptions' => [
            'AutomatedUpdateDate' => <DateTime>,
            'Cancellable' => true || false,
            'CurrentVersion' => '<string>',
            'Description' => '<string>',
            'NewVersion' => '<string>',
            'OptionalDeployment' => true || false,
            'UpdateAvailable' => true || false,
            'UpdateStatus' => 'PENDING_UPDATE|IN_PROGRESS|COMPLETED|NOT_ELIGIBLE|ELIGIBLE',
        ],
        'SnapshotOptions' => [
            'AutomatedSnapshotStartHour' => <integer>,
        ],
        'UpgradeProcessing' => true || false,
        'VPCOptions' => [
            'AvailabilityZones' => ['<string>', ...],
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VPCId' => '<string>',
        ],
    ],
]

Result Details

Members
DomainStatus
  • Required: Yes
  • Type: DomainStatus structure

The current status of the domain.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

DescribeDomainAutoTunes

$result = $client->describeDomainAutoTunes([/* ... */]);
$promise = $client->describeDomainAutoTunesAsync([/* ... */]);

Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.

Parameter Syntax

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

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The domain name for which you want Auto-Tune action details.

MaxResults
  • Type: int

Set this value to limit the number of results returned. If not specified, defaults to 100.

NextToken
  • Type: string

NextToken is sent in case the earlier API call results contain the NextToken. Used for pagination.

Result Syntax

[
    'AutoTunes' => [
        [
            'AutoTuneDetails' => [
                'ScheduledAutoTuneDetails' => [
                    'Action' => '<string>',
                    'ActionType' => 'JVM_HEAP_SIZE_TUNING|JVM_YOUNG_GEN_TUNING',
                    'Date' => <DateTime>,
                    'Severity' => 'LOW|MEDIUM|HIGH',
                ],
            ],
            'AutoTuneType' => 'SCHEDULED_ACTION',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
AutoTunes
  • Type: Array of AutoTune structures

The list of setting adjustments that Auto-Tune has made to the domain. See Auto-Tune for Amazon OpenSearch Service for more information.

NextToken
  • Type: string

An identifier to allow retrieval of paginated results.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

DescribeDomainChangeProgress

$result = $client->describeDomainChangeProgress([/* ... */]);
$promise = $client->describeDomainChangeProgressAsync([/* ... */]);

Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.

Parameter Syntax

$result = $client->describeDomainChangeProgress([
    'ChangeId' => '<string>',
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ChangeId
  • Type: string

The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.

DomainName
  • Required: Yes
  • Type: string

The domain you want to get the progress information about.

Result Syntax

[
    'ChangeProgressStatus' => [
        'ChangeId' => '<string>',
        'ChangeProgressStages' => [
            [
                'Description' => '<string>',
                'LastUpdated' => <DateTime>,
                'Name' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'CompletedProperties' => ['<string>', ...],
        'PendingProperties' => ['<string>', ...],
        'StartTime' => <DateTime>,
        'Status' => 'PENDING|PROCESSING|COMPLETED|FAILED',
        'TotalNumberOfStages' => <integer>,
    ],
]

Result Details

Members
ChangeProgressStatus
  • Type: ChangeProgressStatusDetails structure

Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

DescribeDomainConfig

$result = $client->describeDomainConfig([/* ... */]);
$promise = $client->describeDomainConfigAsync([/* ... */]);

Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.

Parameter Syntax

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

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The domain you want to get information about.

Result Syntax

[
    'DomainConfig' => [
        'AccessPolicies' => [
            'Options' => '<string>',
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AdvancedOptions' => [
            'Options' => ['<string>', ...],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AdvancedSecurityOptions' => [
            'Options' => [
                'AnonymousAuthDisableDate' => <DateTime>,
                'AnonymousAuthEnabled' => true || false,
                'Enabled' => true || false,
                'InternalUserDatabaseEnabled' => true || false,
                'SAMLOptions' => [
                    'Enabled' => true || false,
                    'Idp' => [
                        'EntityId' => '<string>',
                        'MetadataContent' => '<string>',
                    ],
                    'RolesKey' => '<string>',
                    'SessionTimeoutMinutes' => <integer>,
                    'SubjectKey' => '<string>',
                ],
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AutoTuneOptions' => [
            'Options' => [
                'DesiredState' => 'ENABLED|DISABLED',
                'MaintenanceSchedules' => [
                    [
                        'CronExpressionForRecurrence' => '<string>',
                        'Duration' => [
                            'Unit' => 'HOURS',
                            'Value' => <integer>,
                        ],
                        'StartAt' => <DateTime>,
                    ],
                    // ...
                ],
                'RollbackOnDisable' => 'NO_ROLLBACK|DEFAULT_ROLLBACK',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'ErrorMessage' => '<string>',
                'PendingDeletion' => true || false,
                'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'ChangeProgressDetails' => [
            'ChangeId' => '<string>',
            'Message' => '<string>',
        ],
        'ClusterConfig' => [
            'Options' => [
                'ColdStorageOptions' => [
                    'Enabled' => true || false,
                ],
                'DedicatedMasterCount' => <integer>,
                'DedicatedMasterEnabled' => true || false,
                'DedicatedMasterType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
                'InstanceCount' => <integer>,
                'InstanceType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
                'WarmCount' => <integer>,
                'WarmEnabled' => true || false,
                'WarmType' => 'ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search',
                'ZoneAwarenessConfig' => [
                    'AvailabilityZoneCount' => <integer>,
                ],
                'ZoneAwarenessEnabled' => true || false,
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'CognitoOptions' => [
            'Options' => [
                'Enabled' => true || false,
                'IdentityPoolId' => '<string>',
                'RoleArn' => '<string>',
                'UserPoolId' => '<string>',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'DomainEndpointOptions' => [
            'Options' => [
                'CustomEndpoint' => '<string>',
                'CustomEndpointCertificateArn' => '<string>',
                'CustomEndpointEnabled' => true || false,
                'EnforceHTTPS' => true || false,
                'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'EBSOptions' => [
            'Options' => [
                'EBSEnabled' => true || false,
                'Iops' => <integer>,
                'VolumeSize' => <integer>,
                'VolumeType' => 'standard|gp2|io1',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'EncryptionAtRestOptions' => [
            'Options' => [
                'Enabled' => true || false,
                'KmsKeyId' => '<string>',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'EngineVersion' => [
            'Options' => '<string>',
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'LogPublishingOptions' => [
            'Options' => [
                '<LogType>' => [
                    'CloudWatchLogsLogGroupArn' => '<string>',
                    'Enabled' => true || false,
                ],
                // ...
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'NodeToNodeEncryptionOptions' => [
            'Options' => [
                'Enabled' => true || false,
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'SnapshotOptions' => [
            'Options' => [
                'AutomatedSnapshotStartHour' => <integer>,
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'VPCOptions' => [
            'Options' => [
                'AvailabilityZones' => ['<string>', ...],
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
                'VPCId' => '<string>',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
    ],
]

Result Details

Members
DomainConfig
  • Required: Yes
  • Type: DomainConfig structure

The configuration information of the domain requested in the DescribeDomainConfig request.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

DescribeDomains

$result = $client->describeDomains([/* ... */]);
$promise = $client->describeDomainsAsync([/* ... */]);

Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.

Parameter Syntax

$result = $client->describeDomains([
    'DomainNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

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

The domains for which you want information.

Result Syntax

[
    'DomainStatusList' => [
        [
            'ARN' => '<string>',
            'AccessPolicies' => '<string>',
            'AdvancedOptions' => ['<string>', ...],
            'AdvancedSecurityOptions' => [
                'AnonymousAuthDisableDate' => <DateTime>,
                'AnonymousAuthEnabled' => true || false,
                'Enabled' => true || false,
                'InternalUserDatabaseEnabled' => true || false,
                'SAMLOptions' => [
                    'Enabled' => true || false,
                    'Idp' => [
                        'EntityId' => '<string>',
                        'MetadataContent' => '<string>',
                    ],
                    'RolesKey' => '<string>',
                    'SessionTimeoutMinutes' => <integer>,
                    'SubjectKey' => '<string>',
                ],
            ],
            'AutoTuneOptions' => [
                'ErrorMessage' => '<string>',
                'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
            ],
            'ChangeProgressDetails' => [
                'ChangeId' => '<string>',
                'Message' => '<string>',
            ],
            'ClusterConfig' => [
                'ColdStorageOptions' => [
                    'Enabled' => true || false,
                ],
                'DedicatedMasterCount' => <integer>,
                'DedicatedMasterEnabled' => true || false,
                'DedicatedMasterType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
                'InstanceCount' => <integer>,
                'InstanceType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
                'WarmCount' => <integer>,
                'WarmEnabled' => true || false,
                'WarmType' => 'ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search',
                'ZoneAwarenessConfig' => [
                    'AvailabilityZoneCount' => <integer>,
                ],
                'ZoneAwarenessEnabled' => true || false,
            ],
            'CognitoOptions' => [
                'Enabled' => true || false,
                'IdentityPoolId' => '<string>',
                'RoleArn' => '<string>',
                'UserPoolId' => '<string>',
            ],
            'Created' => true || false,
            'Deleted' => true || false,
            'DomainEndpointOptions' => [
                'CustomEndpoint' => '<string>',
                'CustomEndpointCertificateArn' => '<string>',
                'CustomEndpointEnabled' => true || false,
                'EnforceHTTPS' => true || false,
                'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
            ],
            'DomainId' => '<string>',
            'DomainName' => '<string>',
            'EBSOptions' => [
                'EBSEnabled' => true || false,
                'Iops' => <integer>,
                'VolumeSize' => <integer>,
                'VolumeType' => 'standard|gp2|io1',
            ],
            'EncryptionAtRestOptions' => [
                'Enabled' => true || false,
                'KmsKeyId' => '<string>',
            ],
            'Endpoint' => '<string>',
            'Endpoints' => ['<string>', ...],
            'EngineVersion' => '<string>',
            'LogPublishingOptions' => [
                '<LogType>' => [
                    'CloudWatchLogsLogGroupArn' => '<string>',
                    'Enabled' => true || false,
                ],
                // ...
            ],
            'NodeToNodeEncryptionOptions' => [
                'Enabled' => true || false,
            ],
            'Processing' => true || false,
            'ServiceSoftwareOptions' => [
                'AutomatedUpdateDate' => <DateTime>,
                'Cancellable' => true || false,
                'CurrentVersion' => '<string>',
                'Description' => '<string>',
                'NewVersion' => '<string>',
                'OptionalDeployment' => true || false,
                'UpdateAvailable' => true || false,
                'UpdateStatus' => 'PENDING_UPDATE|IN_PROGRESS|COMPLETED|NOT_ELIGIBLE|ELIGIBLE',
            ],
            'SnapshotOptions' => [
                'AutomatedSnapshotStartHour' => <integer>,
            ],
            'UpgradeProcessing' => true || false,
            'VPCOptions' => [
                'AvailabilityZones' => ['<string>', ...],
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
                'VPCId' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
DomainStatusList
  • Required: Yes
  • Type: Array of DomainStatus structures

The status of the domains requested in the DescribeDomains request.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

DescribeInboundConnections

$result = $client->describeInboundConnections([/* ... */]);
$promise = $client->describeInboundConnectionsAsync([/* ... */]);

Lists all the inbound cross-cluster connections for a remote domain.

Parameter Syntax

$result = $client->describeInboundConnections([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
  • Type: Array of Filter structures

A list of filters used to match properties for inbound cross-cluster connections. Available Filter values are:

  • connection-id
  • local-domain-info.domain-name
  • local-domain-info.owner-id
  • local-domain-info.region
  • remote-domain-info.domain-name

MaxResults
  • Type: int

Set this value to limit the number of results returned. If not specified, defaults to 100.

NextToken
  • Type: string

If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

Result Syntax

[
    'Connections' => [
        [
            'ConnectionId' => '<string>',
            'ConnectionStatus' => [
                'Message' => '<string>',
                'StatusCode' => 'PENDING_ACCEPTANCE|APPROVED|PROVISIONING|ACTIVE|REJECTING|REJECTED|DELETING|DELETED',
            ],
            'LocalDomainInfo' => [
                'AWSDomainInformation' => [
                    'DomainName' => '<string>',
                    'OwnerId' => '<string>',
                    'Region' => '<string>',
                ],
            ],
            'RemoteDomainInfo' => [
                'AWSDomainInformation' => [
                    'DomainName' => '<string>',
                    'OwnerId' => '<string>',
                    'Region' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Connections
  • Type: Array of InboundConnection structures

A list of InboundConnection matching the specified filter criteria.

NextToken
  • Type: string

If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

Errors

  • InvalidPaginationTokenException:

    The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

  • DisabledOperationException:

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

DescribeInstanceTypeLimits

$result = $client->describeInstanceTypeLimits([/* ... */]);
$promise = $client->describeInstanceTypeLimitsAsync([/* ... */]);

Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing domain, specify the DomainName to see which limits you can modify.

Parameter Syntax

$result = $client->describeInstanceTypeLimits([
    'DomainName' => '<string>',
    'EngineVersion' => '<string>', // REQUIRED
    'InstanceType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search', // REQUIRED
]);

Parameter Details

Members
DomainName
  • Type: string

The name of the domain you want to modify. Only include this value if you're querying OpenSearch Limits for an existing domain.

EngineVersion
  • Required: Yes
  • Type: string

Version of OpenSearch for which Limits are needed.

InstanceType
  • Required: Yes
  • Type: string

The instance type for an OpenSearch cluster for which OpenSearch Limits are needed.

Result Syntax

[
    'LimitsByRole' => [
        '<InstanceRole>' => [
            'AdditionalLimits' => [
                [
                    'LimitName' => '<string>',
                    'LimitValues' => ['<string>', ...],
                ],
                // ...
            ],
            'InstanceLimits' => [
                'InstanceCountLimits' => [
                    'MaximumInstanceCount' => <integer>,
                    'MinimumInstanceCount' => <integer>,
                ],
            ],
            'StorageTypes' => [
                [
                    'StorageSubTypeName' => '<string>',
                    'StorageTypeLimits' => [
                        [
                            'LimitName' => '<string>',
                            'LimitValues' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'StorageTypeName' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
LimitsByRole
  • Type: Associative array of custom strings keys (InstanceRole) to Limits structures

The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:

  • data: If the given InstanceType is used as a data node
  • master: If the given InstanceType is used as a master node
  • ultra_warm: If the given InstanceType is used as a warm node

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • InvalidTypeException:

    An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

  • LimitExceededException:

    An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

DescribeOutboundConnections

$result = $client->describeOutboundConnections([/* ... */]);
$promise = $client->describeOutboundConnectionsAsync([/* ... */]);

Lists all the outbound cross-cluster connections for a local domain.

Parameter Syntax

$result = $client->describeOutboundConnections([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
  • Type: Array of Filter structures

A list of filters used to match properties for outbound cross-cluster connections. Available Filter names for this operation are:

  • connection-id
  • remote-domain-info.domain-name
  • remote-domain-info.owner-id
  • remote-domain-info.region
  • local-domain-info.domain-name

MaxResults
  • Type: int

Set this value to limit the number of results returned. If not specified, defaults to 100.

NextToken
  • Type: string

NextToken is sent in case the earlier API call results contain the NextToken parameter. Used for pagination.

Result Syntax

[
    'Connections' => [
        [
            'ConnectionAlias' => '<string>',
            'ConnectionId' => '<string>',
            'ConnectionStatus' => [
                'Message' => '<string>',
                'StatusCode' => 'VALIDATING|VALIDATION_FAILED|PENDING_ACCEPTANCE|APPROVED|PROVISIONING|ACTIVE|REJECTING|REJECTED|DELETING|DELETED',
            ],
            'LocalDomainInfo' => [
                'AWSDomainInformation' => [
                    'DomainName' => '<string>',
                    'OwnerId' => '<string>',
                    'Region' => '<string>',
                ],
            ],
            'RemoteDomainInfo' => [
                'AWSDomainInformation' => [
                    'DomainName' => '<string>',
                    'OwnerId' => '<string>',
                    'Region' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Connections
  • Type: Array of OutboundConnection structures

A list of OutboundConnection matching the specified filter criteria.

NextToken
  • Type: string

If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

Errors

  • InvalidPaginationTokenException:

    The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

  • DisabledOperationException:

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

DescribePackages

$result = $client->describePackages([/* ... */]);
$promise = $client->describePackagesAsync([/* ... */]);

Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.

Parameter Syntax

$result = $client->describePackages([
    'Filters' => [
        [
            'Name' => 'PackageID|PackageName|PackageStatus',
            'Value' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
  • Type: Array of DescribePackagesFilter structures

Only returns packages that match the DescribePackagesFilterList values.

MaxResults
  • Type: int

Limits results to a maximum number of packages.

NextToken
  • Type: string

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

Result Syntax

[
    'NextToken' => '<string>',
    'PackageDetailsList' => [
        [
            'AvailablePackageVersion' => '<string>',
            'CreatedAt' => <DateTime>,
            'ErrorDetails' => [
                'ErrorMessage' => '<string>',
                'ErrorType' => '<string>',
            ],
            'LastUpdatedAt' => <DateTime>,
            'PackageDescription' => '<string>',
            'PackageID' => '<string>',
            'PackageName' => '<string>',
            'PackageStatus' => 'COPYING|COPY_FAILED|VALIDATING|VALIDATION_FAILED|AVAILABLE|DELETING|DELETED|DELETE_FAILED',
            'PackageType' => 'TXT-DICTIONARY',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string
PackageDetailsList
  • Type: Array of PackageDetails structures

List of PackageDetails objects.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • AccessDeniedException:

    An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

DescribeReservedInstanceOfferings

$result = $client->describeReservedInstanceOfferings([/* ... */]);
$promise = $client->describeReservedInstanceOfferingsAsync([/* ... */]);

Lists available reserved OpenSearch instance offerings.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

Set this value to limit the number of results returned. If not specified, defaults to 100.

NextToken
  • Type: string

Provides an identifier to allow retrieval of paginated results.

ReservedInstanceOfferingId
  • Type: string

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

Result Syntax

[
    'NextToken' => '<string>',
    'ReservedInstanceOfferings' => [
        [
            'CurrencyCode' => '<string>',
            'Duration' => <integer>,
            'FixedPrice' => <float>,
            'InstanceType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
            'PaymentOption' => 'ALL_UPFRONT|PARTIAL_UPFRONT|NO_UPFRONT',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => <float>,
                    'RecurringChargeFrequency' => '<string>',
                ],
                // ...
            ],
            'ReservedInstanceOfferingId' => '<string>',
            'UsagePrice' => <float>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

Provides an identifier to allow retrieval of paginated results.

ReservedInstanceOfferings
  • Type: Array of ReservedInstanceOffering structures

List of reserved OpenSearch instance offerings

Errors

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

  • DisabledOperationException:

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

DescribeReservedInstances

$result = $client->describeReservedInstances([/* ... */]);
$promise = $client->describeReservedInstancesAsync([/* ... */]);

Returns information about reserved OpenSearch instances for this account.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

Set this value to limit the number of results returned. If not specified, defaults to 100.

NextToken
  • Type: string

Provides an identifier to allow retrieval of paginated results.

ReservedInstanceId
  • Type: string

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.

Result Syntax

[
    'NextToken' => '<string>',
    'ReservedInstances' => [
        [
            'BillingSubscriptionId' => <integer>,
            'CurrencyCode' => '<string>',
            'Duration' => <integer>,
            'FixedPrice' => <float>,
            'InstanceCount' => <integer>,
            'InstanceType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
            'PaymentOption' => 'ALL_UPFRONT|PARTIAL_UPFRONT|NO_UPFRONT',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => <float>,
                    'RecurringChargeFrequency' => '<string>',
                ],
                // ...
            ],
            'ReservationName' => '<string>',
            'ReservedInstanceId' => '<string>',
            'ReservedInstanceOfferingId' => '<string>',
            'StartTime' => <DateTime>,
            'State' => '<string>',
            'UsagePrice' => <float>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

Provides an identifier to allow retrieval of paginated results.

ReservedInstances
  • Type: Array of ReservedInstance structures

List of reserved OpenSearch instances.

Errors

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

  • DisabledOperationException:

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

DissociatePackage

$result = $client->dissociatePackage([/* ... */]);
$promise = $client->dissociatePackageAsync([/* ... */]);

Dissociates a package from the Amazon OpenSearch Service domain.

Parameter Syntax

$result = $client->dissociatePackage([
    'DomainName' => '<string>', // REQUIRED
    'PackageID' => '<string>', // REQUIRED
]);

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The name of the domain to associate the package with.

PackageID
  • Required: Yes
  • Type: string

The internal ID of the package to associate with a domain. Use DescribePackages to find this value.

Result Syntax

[
    'DomainPackageDetails' => [
        'DomainName' => '<string>',
        'DomainPackageStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ACTIVE|DISSOCIATING|DISSOCIATION_FAILED',
        'ErrorDetails' => [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        'LastUpdated' => <DateTime>,
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageType' => 'TXT-DICTIONARY',
        'PackageVersion' => '<string>',
        'ReferencePath' => '<string>',
    ],
]

Result Details

Members
DomainPackageDetails
  • Type: DomainPackageDetails structure

DomainPackageDetails

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • AccessDeniedException:

    An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

  • ConflictException:

    An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

GetCompatibleVersions

$result = $client->getCompatibleVersions([/* ... */]);
$promise = $client->getCompatibleVersionsAsync([/* ... */]);

Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch. You can optionally pass a DomainName to get all upgrade-compatible versions of OpenSearch/Elasticsearch for that specific domain.

Parameter Syntax

$result = $client->getCompatibleVersions([
    'DomainName' => '<string>',
]);

Parameter Details

Members
DomainName
  • Type: string

The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Result Syntax

[
    'CompatibleVersions' => [
        [
            'SourceVersion' => '<string>',
            'TargetVersions' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
CompatibleVersions
  • Type: Array of CompatibleVersionsMap structures

A map of compatible OpenSearch versions returned as part of the GetCompatibleVersions operation.

Errors

  • BaseException:

    An error occurred while processing the request.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • DisabledOperationException:

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

GetPackageVersionHistory

$result = $client->getPackageVersionHistory([/* ... */]);
$promise = $client->getPackageVersionHistoryAsync([/* ... */]);

Returns a list of package versions, along with their creation time and commit message.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

Limits results to a maximum number of package versions.

NextToken
  • Type: string

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

PackageID
  • Required: Yes
  • Type: string

Returns an audit history of package versions.

Result Syntax

[
    'NextToken' => '<string>',
    'PackageID' => '<string>',
    'PackageVersionHistoryList' => [
        [
            'CommitMessage' => '<string>',
            'CreatedAt' => <DateTime>,
            'PackageVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string
PackageID
  • Type: string
PackageVersionHistoryList
  • Type: Array of PackageVersionHistory structures

List of PackageVersionHistory objects.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • AccessDeniedException:

    An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

GetUpgradeHistory

$result = $client->getUpgradeHistory([/* ... */]);
$promise = $client->getUpgradeHistoryAsync([/* ... */]);

Retrieves the complete history of the last 10 upgrades performed on the domain.

Parameter Syntax

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

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

MaxResults
  • Type: int

Set this value to limit the number of results returned.

NextToken
  • Type: string

Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

Result Syntax

[
    'NextToken' => '<string>',
    'UpgradeHistories' => [
        [
            'StartTimestamp' => <DateTime>,
            'StepsList' => [
                [
                    'Issues' => ['<string>', ...],
                    'ProgressPercent' => <float>,
                    'UpgradeStep' => 'PRE_UPGRADE_CHECK|SNAPSHOT|UPGRADE',
                    'UpgradeStepStatus' => 'IN_PROGRESS|SUCCEEDED|SUCCEEDED_WITH_ISSUES|FAILED',
                ],
                // ...
            ],
            'UpgradeName' => '<string>',
            'UpgradeStatus' => 'IN_PROGRESS|SUCCEEDED|SUCCEEDED_WITH_ISSUES|FAILED',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

Pagination token that needs to be supplied to the next call to get the next page of results.

UpgradeHistories
  • Type: Array of UpgradeHistory structures

A list of UpgradeHistory objects corresponding to each upgrade or upgrade eligibility check performed on a domain returned as part of the GetUpgradeHistoryResponse object.

Errors

  • BaseException:

    An error occurred while processing the request.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • DisabledOperationException:

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

GetUpgradeStatus

$result = $client->getUpgradeStatus([/* ... */]);
$promise = $client->getUpgradeStatusAsync([/* ... */]);

Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.

Parameter Syntax

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

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Result Syntax

[
    'StepStatus' => 'IN_PROGRESS|SUCCEEDED|SUCCEEDED_WITH_ISSUES|FAILED',
    'UpgradeName' => '<string>',
    'UpgradeStep' => 'PRE_UPGRADE_CHECK|SNAPSHOT|UPGRADE',
]

Result Details

Members
StepStatus
  • Type: string

One of four statuses an upgrade have, returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

UpgradeName
  • Type: string

A string that briefly describes the update.

UpgradeStep
  • Type: string

One of three steps an upgrade or upgrade eligibility check goes through:

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

Errors

  • BaseException:

    An error occurred while processing the request.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • DisabledOperationException:

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

ListDomainNames

$result = $client->listDomainNames([/* ... */]);
$promise = $client->listDomainNamesAsync([/* ... */]);

Returns the names of all domains owned by the current user's account.

Parameter Syntax

$result = $client->listDomainNames([
    'EngineType' => 'OpenSearch|Elasticsearch',
]);

Parameter Details

Members
EngineType
  • Type: string

Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'.

Result Syntax

[
    'DomainNames' => [
        [
            'DomainName' => '<string>',
            'EngineType' => 'OpenSearch|Elasticsearch',
        ],
        // ...
    ],
]

Result Details

Members
DomainNames
  • Type: Array of DomainInfo structures

List of domain names and respective engine types.

Errors

  • BaseException:

    An error occurred while processing the request.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

ListDomainsForPackage

$result = $client->listDomainsForPackage([/* ... */]);
$promise = $client->listDomainsForPackageAsync([/* ... */]);

Lists all Amazon OpenSearch Service domains associated with the package.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

Limits the results to a maximum number of domains.

NextToken
  • Type: string

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

PackageID
  • Required: Yes
  • Type: string

The package for which to list associated domains.

Result Syntax

[
    'DomainPackageDetailsList' => [
        [
            'DomainName' => '<string>',
            'DomainPackageStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ACTIVE|DISSOCIATING|DISSOCIATION_FAILED',
            'ErrorDetails' => [
                'ErrorMessage' => '<string>',
                'ErrorType' => '<string>',
            ],
            'LastUpdated' => <DateTime>,
            'PackageID' => '<string>',
            'PackageName' => '<string>',
            'PackageType' => 'TXT-DICTIONARY',
            'PackageVersion' => '<string>',
            'ReferencePath' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
DomainPackageDetailsList
  • Type: Array of DomainPackageDetails structures

List of DomainPackageDetails objects.

NextToken
  • Type: string

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • AccessDeniedException:

    An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

ListInstanceTypeDetails

$result = $client->listInstanceTypeDetails([/* ... */]);
$promise = $client->listInstanceTypeDetailsAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Members
DomainName
  • Type: string

The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

EngineVersion
  • Required: Yes
  • Type: string
MaxResults
  • Type: int

Set this value to limit the number of results returned.

NextToken
  • Type: string

Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

Result Syntax

[
    'InstanceTypeDetails' => [
        [
            'AdvancedSecurityEnabled' => true || false,
            'AppLogsEnabled' => true || false,
            'CognitoEnabled' => true || false,
            'EncryptionEnabled' => true || false,
            'InstanceRole' => ['<string>', ...],
            'InstanceType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
            'WarmEnabled' => true || false,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
InstanceTypeDetails
  • Type: Array of InstanceTypeDetails structures
NextToken
  • Type: string

Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

ListPackagesForDomain

$result = $client->listPackagesForDomain([/* ... */]);
$promise = $client->listPackagesForDomainAsync([/* ... */]);

Lists all packages associated with the Amazon OpenSearch Service domain.

Parameter Syntax

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

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The name of the domain for which you want to list associated packages.

MaxResults
  • Type: int

Limits results to a maximum number of packages.

NextToken
  • Type: string

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

Result Syntax

[
    'DomainPackageDetailsList' => [
        [
            'DomainName' => '<string>',
            'DomainPackageStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ACTIVE|DISSOCIATING|DISSOCIATION_FAILED',
            'ErrorDetails' => [
                'ErrorMessage' => '<string>',
                'ErrorType' => '<string>',
            ],
            'LastUpdated' => <DateTime>,
            'PackageID' => '<string>',
            'PackageName' => '<string>',
            'PackageType' => 'TXT-DICTIONARY',
            'PackageVersion' => '<string>',
            'ReferencePath' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
DomainPackageDetailsList
  • Type: Array of DomainPackageDetails structures

List of DomainPackageDetails objects.

NextToken
  • Type: string

Pagination token to supply to the next call to get the next page of results.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • AccessDeniedException:

    An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

ListTags

$result = $client->listTags([/* ... */]);
$promise = $client->listTagsAsync([/* ... */]);

Returns all tags for the given domain.

Parameter Syntax

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

Parameter Details

Members
ARN
  • Required: Yes
  • Type: string

Specify the ARN of the domain that the tags you want to view are attached to.

Result Syntax

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

Result Details

Members
TagList
  • Type: Array of Tag structures

List of Tag for the requested domain.

Errors

  • BaseException:

    An error occurred while processing the request.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

ListVersions

$result = $client->listVersions([/* ... */]);
$promise = $client->listVersionsAsync([/* ... */]);

List all supported versions of OpenSearch and Elasticsearch.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

Set this value to limit the number of results returned. Value must be greater than 10 or it won't be honored.

NextToken
  • Type: string

Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

Result Syntax

[
    'NextToken' => '<string>',
    'Versions' => ['<string>', ...],
]

Result Details

Members
NextToken
  • Type: string

Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

Versions
  • Type: Array of strings

List of supported OpenSearch versions.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

PurchaseReservedInstanceOffering

$result = $client->purchaseReservedInstanceOffering([/* ... */]);
$promise = $client->purchaseReservedInstanceOfferingAsync([/* ... */]);

Allows you to purchase reserved OpenSearch instances.

Parameter Syntax

$result = $client->purchaseReservedInstanceOffering([
    'InstanceCount' => <integer>,
    'ReservationName' => '<string>', // REQUIRED
    'ReservedInstanceOfferingId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceCount
  • Type: int

The number of OpenSearch instances to reserve.

ReservationName
  • Required: Yes
  • Type: string

A customer-specified identifier to track this reservation.

ReservedInstanceOfferingId
  • Required: Yes
  • Type: string

The ID of the reserved OpenSearch instance offering to purchase.

Result Syntax

[
    'ReservationName' => '<string>',
    'ReservedInstanceId' => '<string>',
]

Result Details

Members
ReservationName
  • Type: string

The customer-specified identifier used to track this reservation.

ReservedInstanceId
  • Type: string

Details of the reserved OpenSearch instance which was purchased.

Errors

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ResourceAlreadyExistsException:

    An exception for creating a resource that already exists. Gives http status code of 400.

  • LimitExceededException:

    An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

  • DisabledOperationException:

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

RejectInboundConnection

$result = $client->rejectInboundConnection([/* ... */]);
$promise = $client->rejectInboundConnectionAsync([/* ... */]);

Allows the remote domain owner to reject an inbound cross-cluster connection request.

Parameter Syntax

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

Parameter Details

Members
ConnectionId
  • Required: Yes
  • Type: string

The ID of the inbound connection to reject.

Result Syntax

[
    'Connection' => [
        'ConnectionId' => '<string>',
        'ConnectionStatus' => [
            'Message' => '<string>',
            'StatusCode' => 'PENDING_ACCEPTANCE|APPROVED|PROVISIONING|ACTIVE|REJECTING|REJECTED|DELETING|DELETED',
        ],
        'LocalDomainInfo' => [
            'AWSDomainInformation' => [
                'DomainName' => '<string>',
                'OwnerId' => '<string>',
                'Region' => '<string>',
            ],
        ],
        'RemoteDomainInfo' => [
            'AWSDomainInformation' => [
                'DomainName' => '<string>',
                'OwnerId' => '<string>',
                'Region' => '<string>',
            ],
        ],
    ],
]

Result Details

Members
Connection
  • Type: InboundConnection structure

The InboundConnection of the rejected inbound connection.

Errors

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • DisabledOperationException:

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

RemoveTags

$result = $client->removeTags([/* ... */]);
$promise = $client->removeTagsAsync([/* ... */]);

Removes the specified set of tags from the given domain.

Parameter Syntax

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

Parameter Details

Members
ARN
  • Required: Yes
  • Type: string

The ARN of the domain from which you want to delete the specified tags.

TagKeys
  • Required: Yes
  • Type: Array of strings

The TagKey list you want to remove from the domain.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • BaseException:

    An error occurred while processing the request.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

StartServiceSoftwareUpdate

$result = $client->startServiceSoftwareUpdate([/* ... */]);
$promise = $client->startServiceSoftwareUpdateAsync([/* ... */]);

Schedules a service software update for an Amazon OpenSearch Service domain.

Parameter Syntax

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

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The name of the domain that you want to update to the latest service software.

Result Syntax

[
    'ServiceSoftwareOptions' => [
        'AutomatedUpdateDate' => <DateTime>,
        'Cancellable' => true || false,
        'CurrentVersion' => '<string>',
        'Description' => '<string>',
        'NewVersion' => '<string>',
        'OptionalDeployment' => true || false,
        'UpdateAvailable' => true || false,
        'UpdateStatus' => 'PENDING_UPDATE|IN_PROGRESS|COMPLETED|NOT_ELIGIBLE|ELIGIBLE',
    ],
]

Result Details

Members
ServiceSoftwareOptions
  • Type: ServiceSoftwareOptions structure

The current status of the OpenSearch service software update.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

UpdateDomainConfig

$result = $client->updateDomainConfig([/* ... */]);
$promise = $client->updateDomainConfigAsync([/* ... */]);

Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.

Parameter Syntax

$result = $client->updateDomainConfig([
    'AccessPolicies' => '<string>',
    'AdvancedOptions' => ['<string>', ...],
    'AdvancedSecurityOptions' => [
        'AnonymousAuthEnabled' => true || false,
        'Enabled' => true || false,
        'InternalUserDatabaseEnabled' => true || false,
        'MasterUserOptions' => [
            'MasterUserARN' => '<string>',
            'MasterUserName' => '<string>',
            'MasterUserPassword' => '<string>',
        ],
        'SAMLOptions' => [
            'Enabled' => true || false,
            'Idp' => [
                'EntityId' => '<string>', // REQUIRED
                'MetadataContent' => '<string>', // REQUIRED
            ],
            'MasterBackendRole' => '<string>',
            'MasterUserName' => '<string>',
            'RolesKey' => '<string>',
            'SessionTimeoutMinutes' => <integer>,
            'SubjectKey' => '<string>',
        ],
    ],
    'AutoTuneOptions' => [
        'DesiredState' => 'ENABLED|DISABLED',
        'MaintenanceSchedules' => [
            [
                'CronExpressionForRecurrence' => '<string>',
                'Duration' => [
                    'Unit' => 'HOURS',
                    'Value' => <integer>,
                ],
                'StartAt' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'RollbackOnDisable' => 'NO_ROLLBACK|DEFAULT_ROLLBACK',
    ],
    'ClusterConfig' => [
        'ColdStorageOptions' => [
            'Enabled' => true || false, // REQUIRED
        ],
        'DedicatedMasterCount' => <integer>,
        'DedicatedMasterEnabled' => true || false,
        'DedicatedMasterType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
        'InstanceCount' => <integer>,
        'InstanceType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
        'WarmCount' => <integer>,
        'WarmEnabled' => true || false,
        'WarmType' => 'ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search',
        'ZoneAwarenessConfig' => [
            'AvailabilityZoneCount' => <integer>,
        ],
        'ZoneAwarenessEnabled' => true || false,
    ],
    'CognitoOptions' => [
        'Enabled' => true || false,
        'IdentityPoolId' => '<string>',
        'RoleArn' => '<string>',
        'UserPoolId' => '<string>',
    ],
    'DomainEndpointOptions' => [
        'CustomEndpoint' => '<string>',
        'CustomEndpointCertificateArn' => '<string>',
        'CustomEndpointEnabled' => true || false,
        'EnforceHTTPS' => true || false,
        'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
    ],
    'DomainName' => '<string>', // REQUIRED
    'DryRun' => true || false,
    'EBSOptions' => [
        'EBSEnabled' => true || false,
        'Iops' => <integer>,
        'VolumeSize' => <integer>,
        'VolumeType' => 'standard|gp2|io1',
    ],
    'EncryptionAtRestOptions' => [
        'Enabled' => true || false,
        'KmsKeyId' => '<string>',
    ],
    'LogPublishingOptions' => [
        '<LogType>' => [
            'CloudWatchLogsLogGroupArn' => '<string>',
            'Enabled' => true || false,
        ],
        // ...
    ],
    'NodeToNodeEncryptionOptions' => [
        'Enabled' => true || false,
    ],
    'SnapshotOptions' => [
        'AutomatedSnapshotStartHour' => <integer>,
    ],
    'VPCOptions' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Members
AccessPolicies
  • Type: string

IAM access policy as a JSON-formatted string.

AdvancedOptions
  • Type: Associative array of custom strings keys (String) to strings

Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced options for more information.

AdvancedSecurityOptions
  • Type: AdvancedSecurityOptionsInput structure

Specifies advanced security options.

AutoTuneOptions
  • Type: AutoTuneOptions structure

Specifies Auto-Tune options.

ClusterConfig
  • Type: ClusterConfig structure

The type and number of instances to instantiate for the domain cluster.

CognitoOptions
  • Type: CognitoOptions structure

Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

DomainEndpointOptions
  • Type: DomainEndpointOptions structure

Options to specify configuration that will be applied to the domain endpoint.

DomainName
  • Required: Yes
  • Type: string

The name of the domain you're updating.

DryRun
  • Type: boolean

This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.

EBSOptions
  • Type: EBSOptions structure

Specify the type and size of the EBS volume to use.

EncryptionAtRestOptions
  • Type: EncryptionAtRestOptions structure

Specifies encryption of data at rest options.

LogPublishingOptions
  • Type: Associative array of custom strings keys (LogType) to LogPublishingOption structures

Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.

NodeToNodeEncryptionOptions
  • Type: NodeToNodeEncryptionOptions structure

Specifies node-to-node encryption options.

SnapshotOptions
  • Type: SnapshotOptions structure

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

VPCOptions
  • Type: VPCOptions structure

Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

Result Syntax

[
    'DomainConfig' => [
        'AccessPolicies' => [
            'Options' => '<string>',
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AdvancedOptions' => [
            'Options' => ['<string>', ...],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AdvancedSecurityOptions' => [
            'Options' => [
                'AnonymousAuthDisableDate' => <DateTime>,
                'AnonymousAuthEnabled' => true || false,
                'Enabled' => true || false,
                'InternalUserDatabaseEnabled' => true || false,
                'SAMLOptions' => [
                    'Enabled' => true || false,
                    'Idp' => [
                        'EntityId' => '<string>',
                        'MetadataContent' => '<string>',
                    ],
                    'RolesKey' => '<string>',
                    'SessionTimeoutMinutes' => <integer>,
                    'SubjectKey' => '<string>',
                ],
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AutoTuneOptions' => [
            'Options' => [
                'DesiredState' => 'ENABLED|DISABLED',
                'MaintenanceSchedules' => [
                    [
                        'CronExpressionForRecurrence' => '<string>',
                        'Duration' => [
                            'Unit' => 'HOURS',
                            'Value' => <integer>,
                        ],
                        'StartAt' => <DateTime>,
                    ],
                    // ...
                ],
                'RollbackOnDisable' => 'NO_ROLLBACK|DEFAULT_ROLLBACK',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'ErrorMessage' => '<string>',
                'PendingDeletion' => true || false,
                'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'ChangeProgressDetails' => [
            'ChangeId' => '<string>',
            'Message' => '<string>',
        ],
        'ClusterConfig' => [
            'Options' => [
                'ColdStorageOptions' => [
                    'Enabled' => true || false,
                ],
                'DedicatedMasterCount' => <integer>,
                'DedicatedMasterEnabled' => true || false,
                'DedicatedMasterType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
                'InstanceCount' => <integer>,
                'InstanceType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search|t2.micro.search|t2.small.search|t2.medium.search|r3.large.search|r3.xlarge.search|r3.2xlarge.search|r3.4xlarge.search|r3.8xlarge.search|i2.xlarge.search|i2.2xlarge.search|d2.xlarge.search|d2.2xlarge.search|d2.4xlarge.search|d2.8xlarge.search|c4.large.search|c4.xlarge.search|c4.2xlarge.search|c4.4xlarge.search|c4.8xlarge.search|r4.large.search|r4.xlarge.search|r4.2xlarge.search|r4.4xlarge.search|r4.8xlarge.search|r4.16xlarge.search|i3.large.search|i3.xlarge.search|i3.2xlarge.search|i3.4xlarge.search|i3.8xlarge.search|i3.16xlarge.search|r6g.large.search|r6g.xlarge.search|r6g.2xlarge.search|r6g.4xlarge.search|r6g.8xlarge.search|r6g.12xlarge.search|m6g.large.search|m6g.xlarge.search|m6g.2xlarge.search|m6g.4xlarge.search|m6g.8xlarge.search|m6g.12xlarge.search|c6g.large.search|c6g.xlarge.search|c6g.2xlarge.search|c6g.4xlarge.search|c6g.8xlarge.search|c6g.12xlarge.search|r6gd.large.search|r6gd.xlarge.search|r6gd.2xlarge.search|r6gd.4xlarge.search|r6gd.8xlarge.search|r6gd.12xlarge.search|r6gd.16xlarge.search|t4g.small.search|t4g.medium.search',
                'WarmCount' => <integer>,
                'WarmEnabled' => true || false,
                'WarmType' => 'ultrawarm1.medium.search|ultrawarm1.large.search|ultrawarm1.xlarge.search',
                'ZoneAwarenessConfig' => [
                    'AvailabilityZoneCount' => <integer>,
                ],
                'ZoneAwarenessEnabled' => true || false,
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'CognitoOptions' => [
            'Options' => [
                'Enabled' => true || false,
                'IdentityPoolId' => '<string>',
                'RoleArn' => '<string>',
                'UserPoolId' => '<string>',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'DomainEndpointOptions' => [
            'Options' => [
                'CustomEndpoint' => '<string>',
                'CustomEndpointCertificateArn' => '<string>',
                'CustomEndpointEnabled' => true || false,
                'EnforceHTTPS' => true || false,
                'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'EBSOptions' => [
            'Options' => [
                'EBSEnabled' => true || false,
                'Iops' => <integer>,
                'VolumeSize' => <integer>,
                'VolumeType' => 'standard|gp2|io1',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'EncryptionAtRestOptions' => [
            'Options' => [
                'Enabled' => true || false,
                'KmsKeyId' => '<string>',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'EngineVersion' => [
            'Options' => '<string>',
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'LogPublishingOptions' => [
            'Options' => [
                '<LogType>' => [
                    'CloudWatchLogsLogGroupArn' => '<string>',
                    'Enabled' => true || false,
                ],
                // ...
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'NodeToNodeEncryptionOptions' => [
            'Options' => [
                'Enabled' => true || false,
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'SnapshotOptions' => [
            'Options' => [
                'AutomatedSnapshotStartHour' => <integer>,
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'VPCOptions' => [
            'Options' => [
                'AvailabilityZones' => ['<string>', ...],
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
                'VPCId' => '<string>',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
    ],
    'DryRunResults' => [
        'DeploymentType' => '<string>',
        'Message' => '<string>',
    ],
]

Result Details

Members
DomainConfig
  • Required: Yes
  • Type: DomainConfig structure

The status of the updated domain.

DryRunResults
  • Type: DryRunResults structure

Contains result of DryRun.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • InvalidTypeException:

    An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

  • LimitExceededException:

    An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

UpdatePackage

$result = $client->updatePackage([/* ... */]);
$promise = $client->updatePackageAsync([/* ... */]);

Updates a package for use with Amazon OpenSearch Service domains.

Parameter Syntax

$result = $client->updatePackage([
    'CommitMessage' => '<string>',
    'PackageDescription' => '<string>',
    'PackageID' => '<string>', // REQUIRED
    'PackageSource' => [ // REQUIRED
        'S3BucketName' => '<string>',
        'S3Key' => '<string>',
    ],
]);

Parameter Details

Members
CommitMessage
  • Type: string

A commit message for the new version which is shown as part of GetPackageVersionHistoryResponse.

PackageDescription
  • Type: string

A new description of the package.

PackageID
  • Required: Yes
  • Type: string

The unique identifier for the package.

PackageSource
  • Required: Yes
  • Type: PackageSource structure

The Amazon S3 location for importing the package specified as S3BucketName and S3Key

Result Syntax

[
    'PackageDetails' => [
        'AvailablePackageVersion' => '<string>',
        'CreatedAt' => <DateTime>,
        'ErrorDetails' => [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        'LastUpdatedAt' => <DateTime>,
        'PackageDescription' => '<string>',
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageStatus' => 'COPYING|COPY_FAILED|VALIDATING|VALIDATION_FAILED|AVAILABLE|DELETING|DELETED|DELETE_FAILED',
        'PackageType' => 'TXT-DICTIONARY',
    ],
]

Result Details

Members
PackageDetails
  • Type: PackageDetails structure

Information about the package.

Errors

  • BaseException:

    An error occurred while processing the request.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • LimitExceededException:

    An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • AccessDeniedException:

    An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

UpgradeDomain

$result = $client->upgradeDomain([/* ... */]);
$promise = $client->upgradeDomainAsync([/* ... */]);

Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

Parameter Syntax

$result = $client->upgradeDomain([
    'AdvancedOptions' => ['<string>', ...],
    'DomainName' => '<string>', // REQUIRED
    'PerformCheckOnly' => true || false,
    'TargetVersion' => '<string>', // REQUIRED
]);

Parameter Details

Members
AdvancedOptions
  • Type: Associative array of custom strings keys (String) to strings

Exposes select native OpenSearch configuration values from opensearch.yml. Currently, the following advanced options are available:

  • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
  • Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.

For more information, see Advanced cluster parameters.

DomainName
  • Required: Yes
  • Type: string

The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

PerformCheckOnly
  • Type: boolean

When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

TargetVersion
  • Required: Yes
  • Type: string

The version of OpenSearch you intend to upgrade the domain to.

Result Syntax

[
    'AdvancedOptions' => ['<string>', ...],
    'ChangeProgressDetails' => [
        'ChangeId' => '<string>',
        'Message' => '<string>',
    ],
    'DomainName' => '<string>',
    'PerformCheckOnly' => true || false,
    'TargetVersion' => '<string>',
    'UpgradeId' => '<string>',
]

Result Details

Members
AdvancedOptions
  • Type: Associative array of custom strings keys (String) to strings

Exposes select native OpenSearch configuration values from opensearch.yml. Currently, the following advanced options are available:

  • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
  • Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.

For more information, see Advanced cluster parameters.

ChangeProgressDetails
  • Type: ChangeProgressDetails structure

Specifies change details of the domain configuration change.

DomainName
  • Type: string

The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

PerformCheckOnly
  • Type: boolean

When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

TargetVersion
  • Type: string

The version of OpenSearch that you intend to upgrade the domain to.

UpgradeId
  • Type: string

Errors

  • BaseException:

    An error occurred while processing the request.

  • ResourceNotFoundException:

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ResourceAlreadyExistsException:

    An exception for creating a resource that already exists. Gives http status code of 400.

  • DisabledOperationException:

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

  • ValidationException:

    An exception for missing / invalid input fields. Gives http status code of 400.

  • InternalException:

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

Shapes

AWSDomainInformation

Members
DomainName
  • Required: Yes
  • Type: string

The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

OwnerId
  • Type: string
Region
  • Type: string

AccessDeniedException

Description

An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

Members

AccessPoliciesStatus

Description

The configured access rules for the domain's document and search endpoints, and the current status of those rules.

Members
Options
  • Required: Yes
  • Type: string

The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. See Configuring access policiesfor more information.

Status
  • Required: Yes
  • Type: OptionStatus structure

The status of the access policy for the domain. See OptionStatus for the status information that's included.

AdditionalLimit

Description

List of limits that are specific to a given InstanceType and for each of its InstanceRole .

Members
LimitName
  • Type: string

Additional limit is specific to a given InstanceType and for each of its InstanceRole etc.
Attributes and their details:

  • MaximumNumberOfDataNodesSupported
  • This attribute is present on the master node only to specify how much data nodes up to which given ESPartitionInstanceType can support as master node.
  • MaximumNumberOfDataNodesWithoutMasterNode
  • This attribute is present on data node only to specify how much data nodes of given ESPartitionInstanceType up to which you don't need any master nodes to govern them.

LimitValues
  • Type: Array of strings

Value for a given AdditionalLimit$LimitName .

AdvancedOptionsStatus

Description

Status of the advanced options for the specified domain. Currently, the following advanced options are available:

  • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
  • Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.

For more information, see Advanced cluster parameters.

Members
Options
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to strings

The status of advanced options for the specified domain.

Status
  • Required: Yes
  • Type: OptionStatus structure

The OptionStatus for advanced options for the specified domain.

AdvancedSecurityOptions

Description

The advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.

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

Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.

AnonymousAuthEnabled
  • Type: boolean

True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

Enabled
  • Type: boolean

True if advanced security is enabled.

InternalUserDatabaseEnabled
  • Type: boolean

True if the internal user database is enabled.

SAMLOptions
  • Type: SAMLOptionsOutput structure

Describes the SAML application configured for a domain.

AdvancedSecurityOptionsInput

Description

The advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).

Members
AnonymousAuthEnabled
  • Type: boolean

True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

Enabled
  • Type: boolean

True if advanced security is enabled.

InternalUserDatabaseEnabled
  • Type: boolean

True if the internal user database is enabled.

MasterUserOptions
  • Type: MasterUserOptions structure

Credentials for the master user: username and password, ARN, or both.

SAMLOptions
  • Type: SAMLOptionsInput structure

The SAML application configuration for the domain.

AdvancedSecurityOptionsStatus

Description

The status of advanced security options for the specified domain.

Members
Options
  • Required: Yes
  • Type: AdvancedSecurityOptions structure

Advanced security options for the specified domain.

Status
  • Required: Yes
  • Type: OptionStatus structure

Status of the advanced security options for the specified domain.

AutoTune

Description

Specifies the Auto-Tune type and Auto-Tune action details.

Members
AutoTuneDetails
  • Type: AutoTuneDetails structure

Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.

AutoTuneType
  • Type: string

Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.

AutoTuneDetails

Description

Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.

Members
ScheduledAutoTuneDetails
  • Type: ScheduledAutoTuneDetails structure

Specifies details about the scheduled Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.

AutoTuneMaintenanceSchedule

Description

Specifies the Auto-Tune maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.

Members
CronExpressionForRecurrence
  • Type: string

A cron expression for a recurring maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.

Duration
  • Type: Duration structure

Specifies maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.

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

The timestamp at which the Auto-Tune maintenance schedule starts.

AutoTuneOptions

Description

The Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.

Members
DesiredState
  • Type: string

The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

MaintenanceSchedules
  • Type: Array of AutoTuneMaintenanceSchedule structures

A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.

RollbackOnDisable
  • Type: string

The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.

AutoTuneOptionsInput

Description

The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

Members
DesiredState
  • Type: string

The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

MaintenanceSchedules
  • Type: Array of AutoTuneMaintenanceSchedule structures

A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.

AutoTuneOptionsOutput

Description

The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

Members
ErrorMessage
  • Type: string

The error message while enabling or disabling Auto-Tune.

State
  • Type: string

The AutoTuneState for the domain.

AutoTuneOptionsStatus

Description

The Auto-Tune status for the domain.

Members
Options
  • Type: AutoTuneOptions structure

Specifies Auto-Tune options for the domain.

Status
  • Type: AutoTuneStatus structure

The status of the Auto-Tune options for the domain.

AutoTuneStatus

Description

Provides the current Auto-Tune status for the domain.

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

The timestamp of the Auto-Tune options creation date.

ErrorMessage
  • Type: string

The error message while enabling or disabling Auto-Tune.

PendingDeletion
  • Type: boolean

Indicates whether the domain is being deleted.

State
  • Required: Yes
  • Type: string

The AutoTuneState for the domain.

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

The timestamp of when the Auto-Tune options were last updated.

UpdateVersion
  • Type: int

The latest version of the Auto-Tune options.

BaseException

Description

An error occurred while processing the request.

Members
message
  • Type: string

A description of the error.

ChangeProgressDetails

Description

Specifies change details of the domain configuration change.

Members
ChangeId
  • Type: string

The unique change identifier associated with a specific domain configuration change.

Message
  • Type: string

Contains an optional message associated with the domain configuration change.

ChangeProgressStage

Description

A progress stage details of a specific domain configuration change.

Members
Description
  • Type: string

The description of the progress stage.

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

The last updated timestamp of the progress stage.

Name
  • Type: string

The name of the specific progress stage.

Status
  • Type: string

The overall status of a specific progress stage.

ChangeProgressStatusDetails

Description

The progress details of a specific domain configuration change.

Members
ChangeId
  • Type: string

The unique change identifier associated with a specific domain configuration change.

ChangeProgressStages
  • Type: Array of ChangeProgressStage structures

The specific stages that the domain is going through to perform the configuration change.

CompletedProperties
  • Type: Array of strings

The list of properties involved in the domain configuration change that are completed.

PendingProperties
  • Type: Array of strings

The list of properties involved in the domain configuration change that are still in pending.

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

The time at which the configuration change is made on the domain.

Status
  • Type: string

The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED

TotalNumberOfStages
  • Type: int

The total number of stages required for the configuration change.

ClusterConfig

Description

The configuration for the domain cluster, such as the type and number of instances.

Members
ColdStorageOptions
  • Type: ColdStorageOptions structure

Specifies the ColdStorageOptions config for a Domain

DedicatedMasterCount
  • Type: int

Total number of dedicated master nodes, active and on standby, for the cluster.

DedicatedMasterEnabled
  • Type: boolean

A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

DedicatedMasterType
  • Type: string

The instance type for a dedicated master node.

InstanceCount
  • Type: int

The number of instances in the specified domain cluster.

InstanceType
  • Type: string

The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

WarmCount
  • Type: int

The number of UltraWarm nodes in the cluster.

WarmEnabled
  • Type: boolean

True to enable UltraWarm storage.

WarmType
  • Type: string

The instance type for the OpenSearch cluster's warm nodes.

ZoneAwarenessConfig
  • Type: ZoneAwarenessConfig structure

The zone awareness configuration for a domain when zone awareness is enabled.

ZoneAwarenessEnabled
  • Type: boolean

A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

ClusterConfigStatus

Description

The configuration status for the specified domain.

Members
Options
  • Required: Yes
  • Type: ClusterConfig structure

The cluster configuration for the specified domain.

Status
  • Required: Yes
  • Type: OptionStatus structure

The cluster configuration status for the specified domain.

CognitoOptions

Description

Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

Members
Enabled
  • Type: boolean

The option to enable Cognito for OpenSearch Dashboards authentication.

IdentityPoolId
  • Type: string

The Cognito identity pool ID for OpenSearch Dashboards authentication.

RoleArn
  • Type: string

The role ARN that provides OpenSearch permissions for accessing Cognito resources.

UserPoolId
  • Type: string

The Cognito user pool ID for OpenSearch Dashboards authentication.

CognitoOptionsStatus

Description

The status of the Cognito options for the specified domain.

Members
Options
  • Required: Yes
  • Type: CognitoOptions structure

Cognito options for the specified domain.

Status
  • Required: Yes
  • Type: OptionStatus structure

The status of the Cognito options for the specified domain.

ColdStorageOptions

Description

Specifies the configuration for cold storage options such as enabled

Members
Enabled
  • Required: Yes
  • Type: boolean

Enable cold storage option. Accepted values true or false

CompatibleVersionsMap

Description

A map from an EngineVersion to a list of compatible EngineVersion s to which the domain can be upgraded.

Members
SourceVersion
  • Type: string

The current version of OpenSearch a domain is on.

TargetVersions
  • Type: Array of strings

List of supported OpenSearch versions.

ConflictException

Description

An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

Members

DescribePackagesFilter

Description

A filter to apply to the DescribePackage response.

Members
Name
  • Type: string

Any field from PackageDetails.

Value
  • Type: Array of strings

A list of values for the specified field.

DisabledOperationException

Description

An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

Members

DomainConfig

Description

The configuration of a domain.

Members
AccessPolicies
  • Type: AccessPoliciesStatus structure

IAM access policy as a JSON-formatted string.

AdvancedOptions
  • Type: AdvancedOptionsStatus structure

The AdvancedOptions for the domain. See Advanced options for more information.

AdvancedSecurityOptions
  • Type: AdvancedSecurityOptionsStatus structure

Specifies AdvancedSecurityOptions for the domain.

AutoTuneOptions
  • Type: AutoTuneOptionsStatus structure

Specifies AutoTuneOptions for the domain.

ChangeProgressDetails
  • Type: ChangeProgressDetails structure

Specifies change details of the domain configuration change.

ClusterConfig
  • Type: ClusterConfigStatus structure

The ClusterConfig for the domain.

CognitoOptions
  • Type: CognitoOptionsStatus structure

The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

DomainEndpointOptions
  • Type: DomainEndpointOptionsStatus structure

The DomainEndpointOptions for the domain.

EBSOptions
  • Type: EBSOptionsStatus structure

The EBSOptions for the domain.

EncryptionAtRestOptions
  • Type: EncryptionAtRestOptionsStatus structure

The EncryptionAtRestOptions for the domain.

EngineVersion
  • Type: VersionStatus structure

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.

LogPublishingOptions
  • Type: LogPublishingOptionsStatus structure

Log publishing options for the given domain.

NodeToNodeEncryptionOptions
  • Type: NodeToNodeEncryptionOptionsStatus structure

The NodeToNodeEncryptionOptions for the domain.

SnapshotOptions
  • Type: SnapshotOptionsStatus structure

The SnapshotOptions for the domain.

VPCOptions
  • Type: VPCDerivedInfoStatus structure

The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

DomainEndpointOptions

Description

Options to configure the endpoint for the domain.

Members
CustomEndpoint
  • Type: string

The fully qualified domain for your custom endpoint.

CustomEndpointCertificateArn
  • Type: string

The ACM certificate ARN for your custom endpoint.

CustomEndpointEnabled
  • Type: boolean

Whether to enable a custom endpoint for the domain.

EnforceHTTPS
  • Type: boolean

Whether only HTTPS endpoint should be enabled for the domain.

TLSSecurityPolicy
  • Type: string

Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
Can be one of the following values:

  • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
  • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2

DomainEndpointOptionsStatus

Description

The configured endpoint options for the domain and their current status.

Members
Options
  • Required: Yes
  • Type: DomainEndpointOptions structure

Options to configure the endpoint for the domain.

Status
  • Required: Yes
  • Type: OptionStatus structure

The status of the endpoint options for the domain. See OptionStatus for the status information that's included.

DomainInfo

Members
DomainName
  • Type: string

The DomainName.

EngineType
  • Type: string

Specifies the EngineType of the domain.

DomainInformationContainer

Members
AWSDomainInformation
  • Type: AWSDomainInformation structure

DomainPackageDetails

Description

Information on a package associated with a domain.

Members
DomainName
  • Type: string

The name of the domain you've associated a package with.

DomainPackageStatus
  • Type: string

State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.

ErrorDetails
  • Type: ErrorDetails structure

Additional information if the package is in an error state. Null otherwise.

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

The timestamp of the most recent update to the package association status.

PackageID
  • Type: string

The internal ID of the package.

PackageName
  • Type: string

User-specified name of the package.

PackageType
  • Type: string

Currently supports only TXT-DICTIONARY.

PackageVersion
  • Type: string
ReferencePath
  • Type: string

The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.

DomainStatus

Description

The current status of a domain.

Members
ARN
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.

AccessPolicies
  • Type: string

IAM access policy as a JSON-formatted string.

AdvancedOptions
  • Type: Associative array of custom strings keys (String) to strings

The status of the AdvancedOptions.

AdvancedSecurityOptions
  • Type: AdvancedSecurityOptions structure

The current status of the domain's advanced security options.

AutoTuneOptions
  • Type: AutoTuneOptionsOutput structure

The current status of the domain's Auto-Tune options.

ChangeProgressDetails
  • Type: ChangeProgressDetails structure

Specifies change details of the domain configuration change.

ClusterConfig
  • Required: Yes
  • Type: ClusterConfig structure

The type and number of instances in the domain.

CognitoOptions
  • Type: CognitoOptions structure

The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

Created
  • Type: boolean

The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.

Deleted
  • Type: boolean

The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

DomainEndpointOptions
  • Type: DomainEndpointOptions structure

The current status of the domain's endpoint options.

DomainId
  • Required: Yes
  • Type: string

The unique identifier for the specified domain.

DomainName
  • Required: Yes
  • Type: string

The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

EBSOptions
  • Type: EBSOptions structure

The EBSOptions for the specified domain.

EncryptionAtRestOptions
  • Type: EncryptionAtRestOptions structure

The status of the EncryptionAtRestOptions.

Endpoint
  • Type: string

The domain endpoint that you use to submit index and search requests.

Endpoints
  • Type: Associative array of custom strings keys (String) to strings

Map containing the domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

EngineVersion
  • Type: string
LogPublishingOptions
  • Type: Associative array of custom strings keys (LogType) to LogPublishingOption structures

Log publishing options for the given domain.

NodeToNodeEncryptionOptions
  • Type: NodeToNodeEncryptionOptions structure

The status of the NodeToNodeEncryptionOptions.

Processing
  • Type: boolean

The status of the domain configuration. True if Amazon OpenSearch Service is processing configuration changes. False if the configuration is active.

ServiceSoftwareOptions
  • Type: ServiceSoftwareOptions structure

The current status of the domain's service software.

SnapshotOptions
  • Type: SnapshotOptions structure

The status of the SnapshotOptions.

UpgradeProcessing
  • Type: boolean

The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.

VPCOptions
  • Type: VPCDerivedInfo structure

The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

DryRunResults

Members
DeploymentType
  • Type: string

Specifies the way in which Amazon OpenSearch Service applies the update. Possible responses are Blue/Green (the update requires a blue/green deployment), DynamicUpdate (no blue/green required), Undetermined (the domain is undergoing an update and can't predict the deployment type; try again after the update is complete), and None (the request doesn't include any configuration changes).

Message
  • Type: string

Contains an optional message associated with the DryRunResults.

Duration

Description

The maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.

Members
Unit
  • Type: string

The unit of a maintenance schedule duration. Valid value is HOURS. See Auto-Tune for Amazon OpenSearch Service for more information.

Value
  • Type: long (int|float)

Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service for more information.

EBSOptions

Description

Options to enable, disable, and specify the properties of EBS storage volumes.

Members
EBSEnabled
  • Type: boolean

Whether EBS-based storage is enabled.

Iops
  • Type: int

The IOPD for a Provisioned IOPS EBS volume (SSD).

VolumeSize
  • Type: int

Integer to specify the size of an EBS volume.

VolumeType
  • Type: string

The volume type for EBS-based storage.

EBSOptionsStatus

Description

Status of the EBS options for the specified domain.

Members
Options
  • Required: Yes
  • Type: EBSOptions structure

The EBS options for the specified domain.

Status
  • Required: Yes
  • Type: OptionStatus structure

The status of the EBS options for the specified domain.

EncryptionAtRestOptions

Description

Specifies encryption at rest options.

Members
Enabled
  • Type: boolean

The option to enable encryption at rest.

KmsKeyId
  • Type: string

The KMS key ID for encryption at rest options.

EncryptionAtRestOptionsStatus

Description

Status of the encryption At Rest options for the specified domain.

Members
Options
  • Required: Yes
  • Type: EncryptionAtRestOptions structure

The Encryption At Rest options for the specified domain.

Status
  • Required: Yes
  • Type: OptionStatus structure

The status of the Encryption At Rest options for the specified domain.

ErrorDetails

Members
ErrorMessage
  • Type: string
ErrorType
  • Type: string

Filter

Description

A filter used to limit results when describing inbound or outbound cross-cluster connections. Multiple values can be specified per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.

Members
Name
  • Type: string

The name of the filter.

Values
  • Type: Array of strings

Contains one or more values for the filter.

InboundConnection

Description

Details of an inbound connection.

Members
ConnectionId
  • Type: string

The connection ID for the inbound cross-cluster connection.

ConnectionStatus
  • Type: InboundConnectionStatus structure

The InboundConnectionStatus for the outbound connection.

LocalDomainInfo
  • Type: DomainInformationContainer structure

The AWSDomainInformation for the local OpenSearch domain.

RemoteDomainInfo
  • Type: DomainInformationContainer structure

The AWSDomainInformation for the remote OpenSearch domain.

InboundConnectionStatus

Description

The connection status of an inbound cross-cluster connection.

Members
Message
  • Type: string

Verbose information for the inbound connection status.

StatusCode
  • Type: string

The state code for the inbound connection. Can be one of the following:

  • PENDING_ACCEPTANCE: Inbound connection is not yet accepted by the remote domain owner.
  • APPROVED: Inbound connection is pending acceptance by the remote domain owner.
  • PROVISIONING: Inbound connection provisioning is in progress.
  • ACTIVE: Inbound connection is active and ready to use.
  • REJECTING: Inbound connection rejection is in process.
  • REJECTED: Inbound connection is rejected.
  • DELETING: Inbound connection deletion is in progress.
  • DELETED: Inbound connection is deleted and can no longer be used.

InstanceCountLimits

Description

InstanceCountLimits represents the limits on the number of instances that can be created in Amazon OpenSearch Service for a given InstanceType.

Members
MaximumInstanceCount
  • Type: int

Maximum number of instances that can be instantiated for a given InstanceType.

MinimumInstanceCount
  • Type: int

Minimum number of instances that can be instantiated for a given InstanceType.

InstanceLimits

Description

InstanceLimits represents the list of instance-related attributes that are available for a given InstanceType.

Members
InstanceCountLimits
  • Type: InstanceCountLimits structure

InstanceCountLimits represents the limits on the number of instances that can be created in Amazon OpenSearch Service for a given InstanceType.

InstanceTypeDetails

Members
AdvancedSecurityEnabled
  • Type: boolean
AppLogsEnabled
  • Type: boolean
CognitoEnabled
  • Type: boolean
EncryptionEnabled
  • Type: boolean
InstanceRole
  • Type: Array of strings
InstanceType
  • Type: string
WarmEnabled
  • Type: boolean

InternalException

Description

The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

Members

InvalidPaginationTokenException

Description

The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

Members

InvalidTypeException

Description

An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

Members

LimitExceededException

Description

An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

Members

Limits

Description

Limits for a given InstanceType and for each of its roles.
Limits contains the following: StorageTypes , InstanceLimits , and AdditionalLimits

Members
AdditionalLimits
  • Type: Array of AdditionalLimit structures

List of additional limits that are specific to a given InstanceType and for each of its InstanceRole .

InstanceLimits
  • Type: InstanceLimits structure

InstanceLimits represents the list of instance-related attributes that are available for a given InstanceType.

StorageTypes
  • Type: Array of StorageType structures

Storage-related types and attributes that are available for a given InstanceType.

LogPublishingOption

Description

Log Publishing option that is set for a given domain.
Attributes and their details:

  • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
  • Enabled: Whether the log publishing for a given log type is enabled or not.

Members
CloudWatchLogsLogGroupArn
  • Type: string

ARN of the Cloudwatch log group to publish logs to.

Enabled
  • Type: boolean

Whether the given log publishing option is enabled or not.

LogPublishingOptionsStatus

Description

The configured log publishing options for the domain and their current status.

Members
Options
  • Type: Associative array of custom strings keys (LogType) to LogPublishingOption structures

The log publishing options configured for the domain.

Status
  • Type: OptionStatus structure

The status of the log publishing options for the domain. See OptionStatus for the status information that's included.

MasterUserOptions

Description

Credentials for the master user: username and password, ARN, or both.

Members
MasterUserARN
  • Type: string

ARN for the master user (if IAM is enabled).

MasterUserName
  • Type: string

The master user's username, which is stored in the Amazon OpenSearch Service domain's internal database.

MasterUserPassword
  • Type: string

The master user's password, which is stored in the Amazon OpenSearch Service domain's internal database.

NodeToNodeEncryptionOptions

Description

The node-to-node encryption options.

Members
Enabled
  • Type: boolean

True to enable node-to-node encryption.

NodeToNodeEncryptionOptionsStatus

Description

Status of the node-to-node encryption options for the specified domain.

Members
Options
  • Required: Yes
  • Type: NodeToNodeEncryptionOptions structure

The node-to-node encryption options for the specified domain.

Status
  • Required: Yes
  • Type: OptionStatus structure

The status of the node-to-node encryption options for the specified domain.

OptionStatus

Description

Provides the current status of the entity.

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

The timestamp of when the entity was created.

PendingDeletion
  • Type: boolean

Indicates whether the domain is being deleted.

State
  • Required: Yes
  • Type: string

Provides the OptionState for the domain.

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

The timestamp of the last time the entity was updated.

UpdateVersion
  • Type: int

The latest version of the entity.

OutboundConnection

Description

Specifies details about an outbound connection.

Members
ConnectionAlias
  • Type: string

The connection alias for the outbound cross-cluster connection.

ConnectionId
  • Type: string

The connection ID for the outbound cross-cluster connection.

ConnectionStatus
  • Type: OutboundConnectionStatus structure

The OutboundConnectionStatus for the outbound connection.

LocalDomainInfo
  • Type: DomainInformationContainer structure

The DomainInformation for the local OpenSearch domain.

RemoteDomainInfo
  • Type: DomainInformationContainer structure

The DomainInformation for the remote OpenSearch domain.

OutboundConnectionStatus

Description

The connection status of an outbound cross-cluster connection.

Members
Message
  • Type: string

Verbose information for the outbound connection status.

StatusCode
  • Type: string

The state code for the outbound connection. Can be one of the following:

  • VALIDATING: The outbound connection request is being validated.
  • VALIDATION_FAILED: Validation failed for the connection request.
  • PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
  • APPROVED: Outbound connection has been approved by the remote domain owner for getting provisioned.
  • PROVISIONING: Outbound connection request is in process.
  • ACTIVE: Outbound connection is active and ready to use.
  • REJECTING: Outbound connection rejection by remote domain owner is in progress.
  • REJECTED: Outbound connection request is rejected by remote domain owner.
  • DELETING: Outbound connection deletion is in progress.
  • DELETED: Outbound connection is deleted and can no longer be used.

PackageDetails

Description

Basic information about a package.

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

The timestamp of when the package was created.

ErrorDetails
  • Type: ErrorDetails structure

Additional information if the package is in an error state. Null otherwise.

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

User-specified description of the package.

PackageID
  • Type: string

Internal ID of the package.

PackageName
  • Type: string

User-specified name of the package.

PackageStatus
  • Type: string

Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.

PackageType
  • Type: string

Currently supports only TXT-DICTIONARY.

PackageSource

Description

The Amazon S3 location for importing the package specified as S3BucketName and S3Key

Members
S3BucketName
  • Type: string

The name of the Amazon S3 bucket containing the package.

S3Key
  • Type: string

Key (file name) of the package.

PackageVersionHistory

Description

Details of a package version.

Members
CommitMessage
  • Type: string

A message associated with the package version.

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

The timestamp of when the package was created.

PackageVersion
  • Type: string

The package version.

RecurringCharge

Description

Contains the specific price and frequency of a recurring charges for a reserved OpenSearch instance, or for a reserved OpenSearch instance offering.

Members
RecurringChargeAmount
  • Type: double

The monetary amount of the recurring charge.

RecurringChargeFrequency
  • Type: string

The frequency of the recurring charge.

ReservedInstance

Description

Details of a reserved OpenSearch instance.

Members
BillingSubscriptionId
  • Type: long (int|float)
CurrencyCode
  • Type: string

The currency code for the reserved OpenSearch instance offering.

Duration
  • Type: int

The duration, in seconds, for which the OpenSearch instance is reserved.

FixedPrice
  • Type: double

The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.

InstanceCount
  • Type: int

The number of OpenSearch instances that have been reserved.

InstanceType
  • Type: string

The OpenSearch instance type offered by the reserved instance offering.

PaymentOption
  • Type: string

The payment option as defined in the reserved OpenSearch instance offering.

RecurringCharges
  • Type: Array of RecurringCharge structures

The charge to your account regardless of whether you are creating any domains using the instance offering.

ReservationName
  • Type: string

The customer-specified identifier to track this reservation.

ReservedInstanceId
  • Type: string

The unique identifier for the reservation.

ReservedInstanceOfferingId
  • Type: string

The offering identifier.

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

The time the reservation started.

State
  • Type: string

The state of the reserved OpenSearch instance.

UsagePrice
  • Type: double

The rate you are charged for each hour for the domain that is using this reserved instance.

ReservedInstanceOffering

Description

Details of a reserved OpenSearch instance offering.

Members
CurrencyCode
  • Type: string

The currency code for the reserved OpenSearch instance offering.

Duration
  • Type: int

The duration, in seconds, for which the offering will reserve the OpenSearch instance.

FixedPrice
  • Type: double

The upfront fixed charge you will pay to purchase the specific reserved OpenSearch instance offering.

InstanceType
  • Type: string

The OpenSearch instance type offered by the reserved instance offering.

PaymentOption
  • Type: string

Payment option for the reserved OpenSearch instance offering

RecurringCharges
  • Type: Array of RecurringCharge structures

The charge to your account regardless of whether you are creating any domains using the instance offering.

ReservedInstanceOfferingId
  • Type: string

The OpenSearch reserved instance offering identifier.

UsagePrice
  • Type: double

The rate you are charged for each hour the domain that is using the offering is running.

ResourceAlreadyExistsException

Description

An exception for creating a resource that already exists. Gives http status code of 400.

Members

ResourceNotFoundException

Description

An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

Members

SAMLIdp

Description

The SAML identity povider's information.

Members
EntityId
  • Required: Yes
  • Type: string

The unique entity ID of the application in SAML identity provider.

MetadataContent
  • Required: Yes
  • Type: string

The metadata of the SAML application in XML format.

SAMLOptionsInput

Description

The SAML application configuration for the domain.

Members
Enabled
  • Type: boolean

True if SAML is enabled.

Idp
  • Type: SAMLIdp structure

The SAML Identity Provider's information.

MasterBackendRole
  • Type: string

The backend role that the SAML master user is mapped to.

MasterUserName
  • Type: string

The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.

RolesKey
  • Type: string

Element of the SAML assertion to use for backend roles. Default is roles.

SessionTimeoutMinutes
  • Type: int

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

SubjectKey
  • Type: string

Element of the SAML assertion to use for username. Default is NameID.

SAMLOptionsOutput

Description

Describes the SAML application configured for the domain.

Members
Enabled
  • Type: boolean

True if SAML is enabled.

Idp
  • Type: SAMLIdp structure

Describes the SAML identity provider's information.

RolesKey
  • Type: string

The key used for matching the SAML roles attribute.

SessionTimeoutMinutes
  • Type: int

The duration, in minutes, after which a user session becomes inactive.

SubjectKey
  • Type: string

The key used for matching the SAML subject attribute.

ScheduledAutoTuneDetails

Description

Specifies details about the scheduled Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.

Members
Action
  • Type: string

The Auto-Tune action description.

ActionType
  • Type: string

The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.

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

The timestamp of the Auto-Tune action scheduled for the domain.

Severity
  • Type: string

The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.

ServiceSoftwareOptions

Description

The current options of an domain service software options.

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

The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

Cancellable
  • Type: boolean

True if you're able to cancel your service software version update. False if you can't cancel your service software update.

CurrentVersion
  • Type: string

The current service software version present on the domain.

Description
  • Type: string

The description of the UpdateStatus.

NewVersion
  • Type: string

The new service software version if one is available.

OptionalDeployment
  • Type: boolean

True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.

UpdateAvailable
  • Type: boolean

True if you're able to update your service software version. False if you can't update your service software version.

UpdateStatus
  • Type: string

The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

SnapshotOptions

Description

The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.

Members
AutomatedSnapshotStartHour
  • Type: int

The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.

SnapshotOptionsStatus

Description

Status of a daily automated snapshot.

Members
Options
  • Required: Yes
  • Type: SnapshotOptions structure

The daily snapshot options specified for the domain.

Status
  • Required: Yes
  • Type: OptionStatus structure

The status of a daily automated snapshot.

StorageType

Description

StorageTypes represents the list of storage-related types and their attributes that are available for a given InstanceType.

Members
StorageSubTypeName
  • Type: string

Sub-type of the given storage type. List of available sub-storage options: "instance" storageType has no storageSubType. "ebs" storageType has the following valid storageSubTypes:

  1. standard
  2. gp2
  3. io1
See VolumeType for more information regarding each EBS storage option.

StorageTypeLimits
  • Type: Array of StorageTypeLimit structures

Limits that are applicable for the given storage type.

StorageTypeName
  • Type: string

Type of storage. List of available storage options:

  1. instance
  2. Built-in storage available for the instance
  3. ebs
  4. Elastic block storage attached to the instance

StorageTypeLimit

Description

Limits that are applicable for the given storage type.

Members
LimitName
  • Type: string

Name of storage limits that are applicable for the given storage type. If StorageType is "ebs", the following storage options are applicable:

  1. MinimumVolumeSize
  2. Minimum amount of volume size that is applicable for the given storage type. Can be empty if not applicable.
  3. MaximumVolumeSize
  4. Maximum amount of volume size that is applicable for the given storage type. Can be empty if not applicable.
  5. MaximumIops
  6. Maximum amount of Iops that is applicable for given the storage type. Can be empty if not applicable.
  7. MinimumIops
  8. Minimum amount of Iops that is applicable for given the storage type. Can be empty if not applicable.

LimitValues
  • Type: Array of strings

Values for the StorageTypeLimit$LimitName .

Tag

Description

A key value pair for a resource tag.

Members
Key
  • Required: Yes
  • Type: string

The TagKey, the name of the tag. Tag keys must be unique for the domain to which they are attached.

Value
  • Required: Yes
  • Type: string

The TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

UpgradeHistory

Description

History of the last 10 upgrades and upgrade eligibility checks.

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

UTC timestamp at which the upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.

StepsList
  • Type: Array of UpgradeStepItem structures

A list of UpgradeStepItem s representing information about each step performed as part of a specific upgrade or upgrade eligibility check.

UpgradeName
  • Type: string

A string that briefly describes the upgrade.

UpgradeStatus
  • Type: string

The current status of the upgrade. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

UpgradeStepItem

Description

Represents a single step of the upgrade or upgrade eligibility check workflow.

Members
Issues
  • Type: Array of strings

A list of strings containing detailed information about the errors encountered in a particular step.

ProgressPercent
  • Type: double

The floating point value representing the progress percentage of a particular step.

UpgradeStep
  • Type: string

One of three steps an upgrade or upgrade eligibility check goes through:

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

UpgradeStepStatus
  • Type: string

The current status of the upgrade. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

VPCDerivedInfo

Description

Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

Members
AvailabilityZones
  • Type: Array of strings

The Availability Zones for the domain. Exists only if the domain was created with VPCOptions.

SecurityGroupIds
  • Type: Array of strings

The security groups for the VPC endpoint.

SubnetIds
  • Type: Array of strings

The subnets for the VPC endpoint.

VPCId
  • Type: string

The VPC ID for the domain. Exists only if the domain was created with VPCOptions.

VPCDerivedInfoStatus

Description

Status of the VPC options for the specified domain.

Members
Options
  • Required: Yes
  • Type: VPCDerivedInfo structure

The VPC options for the specified domain.

Status
  • Required: Yes
  • Type: OptionStatus structure

The status of the VPC options for the specified domain.

VPCOptions

Description

Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

Members
SecurityGroupIds
  • Type: Array of strings

The security groups for the VPC endpoint.

SubnetIds
  • Type: Array of strings

The subnets for the VPC endpoint.

ValidationException

Description

An exception for missing / invalid input fields. Gives http status code of 400.

Members

VersionStatus

Description

The status of the OpenSearch version options for the specified OpenSearch domain.

Members
Options
  • Required: Yes
  • Type: string

The OpenSearch version for the specified OpenSearch domain.

Status
  • Required: Yes
  • Type: OptionStatus structure

The status of the OpenSearch version options for the specified OpenSearch domain.

ZoneAwarenessConfig

Description

The zone awareness configuration for the domain cluster, such as the number of availability zones.

Members
AvailabilityZoneCount
  • Type: int

An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

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