AcceptInboundConnection

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

Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Connection' => [
        'ConnectionId' => '<string>',
        'ConnectionMode' => 'DIRECT|VPC_ENDPOINT',
        '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

Errors

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

LimitExceededException:

An exception for trying to create more than the allowed number of resources or sub-resources.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

AddDataSource

$result = $client->addDataSource([/* ... */]);
$promise = $client->addDataSourceAsync([/* ... */]);

Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.

Parameter Syntax

$result = $client->addDataSource([
    'DataSourceType' => [ // REQUIRED
        'S3GlueDataCatalog' => [
            'RoleArn' => '<string>',
        ],
    ],
    'Description' => '<string>',
    'DomainName' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

DependencyFailureException:

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

LimitExceededException:

An exception for trying to create more than the allowed number of resources or sub-resources.

AddTags

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BaseException:

An error occurred while processing the request.

LimitExceededException:

An exception for trying to create more than the allowed number of resources or sub-resources.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

AssociatePackage

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

Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

Parameter Syntax

$result = $client->associatePackage([
    'AssociationConfiguration' => [
        'KeyStoreAccessOption' => [
            'KeyAccessRoleArn' => '<string>',
            'KeyStoreAccessEnabled' => true || false, // REQUIRED
        ],
    ],
    'DomainName' => '<string>', // REQUIRED
    'PackageID' => '<string>', // REQUIRED
    'PrerequisitePackageIDList' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'DomainPackageDetails' => [
        'AssociationConfiguration' => [
            'KeyStoreAccessOption' => [
                'KeyAccessRoleArn' => '<string>',
                'KeyStoreAccessEnabled' => true || false,
            ],
        ],
        'DomainName' => '<string>',
        'DomainPackageStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ACTIVE|DISSOCIATING|DISSOCIATION_FAILED',
        'ErrorDetails' => [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        'LastUpdated' => <DateTime>,
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageType' => 'TXT-DICTIONARY|ZIP-PLUGIN|PACKAGE-LICENSE|PACKAGE-CONFIG',
        'PackageVersion' => '<string>',
        'PrerequisitePackageIDList' => ['<string>', ...],
        'ReferencePath' => '<string>',
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException:

An error occurred because you don't have permissions to access the resource.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

ConflictException:

An error occurred because the client attempts to remove a resource that is currently in use.

AssociatePackages

$result = $client->associatePackages([/* ... */]);
$promise = $client->associatePackagesAsync([/* ... */]);

Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.

Parameter Syntax

$result = $client->associatePackages([
    'DomainName' => '<string>', // REQUIRED
    'PackageList' => [ // REQUIRED
        [
            'AssociationConfiguration' => [
                'KeyStoreAccessOption' => [
                    'KeyAccessRoleArn' => '<string>',
                    'KeyStoreAccessEnabled' => true || false, // REQUIRED
                ],
            ],
            'PackageID' => '<string>', // REQUIRED
            'PrerequisitePackageIDList' => ['<string>', ...],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DomainPackageDetailsList' => [
        [
            'AssociationConfiguration' => [
                'KeyStoreAccessOption' => [
                    'KeyAccessRoleArn' => '<string>',
                    'KeyStoreAccessEnabled' => true || false,
                ],
            ],
            'DomainName' => '<string>',
            'DomainPackageStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ACTIVE|DISSOCIATING|DISSOCIATION_FAILED',
            'ErrorDetails' => [
                'ErrorMessage' => '<string>',
                'ErrorType' => '<string>',
            ],
            'LastUpdated' => <DateTime>,
            'PackageID' => '<string>',
            'PackageName' => '<string>',
            'PackageType' => 'TXT-DICTIONARY|ZIP-PLUGIN|PACKAGE-LICENSE|PACKAGE-CONFIG',
            'PackageVersion' => '<string>',
            'PrerequisitePackageIDList' => ['<string>', ...],
            'ReferencePath' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

ConflictException:

An error occurred because the client attempts to remove a resource that is currently in use.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

AuthorizeVpcEndpointAccess

$result = $client->authorizeVpcEndpointAccess([/* ... */]);
$promise = $client->authorizeVpcEndpointAccessAsync([/* ... */]);

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Parameter Syntax

$result = $client->authorizeVpcEndpointAccess([
    'Account' => '<string>',
    'DomainName' => '<string>', // REQUIRED
    'Service' => 'application.opensearchservice.amazonaws.com',
]);

Parameter Details

Result Syntax

[
    'AuthorizedPrincipal' => [
        'Principal' => '<string>',
        'PrincipalType' => 'AWS_ACCOUNT|AWS_SERVICE',
    ],
]

Result Details

Errors

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

LimitExceededException:

An exception for trying to create more than the allowed number of resources or sub-resources.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

BaseException:

An error occurred while processing the request.

CancelDomainConfigChange

$result = $client->cancelDomainConfigChange([/* ... */]);
$promise = $client->cancelDomainConfigChangeAsync([/* ... */]);

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

Parameter Syntax

$result = $client->cancelDomainConfigChange([
    'DomainName' => '<string>', // REQUIRED
    'DryRun' => true || false,
]);

Parameter Details

Result Syntax

[
    'CancelledChangeIds' => ['<string>', ...],
    'CancelledChangeProperties' => [
        [
            'ActiveValue' => '<string>',
            'CancelledValue' => '<string>',
            'PropertyName' => '<string>',
        ],
        // ...
    ],
    'DryRun' => true || false,
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

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 domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

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

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

Creates an OpenSearch Application.

Parameter Syntax

$result = $client->createApplication([
    'appConfigs' => [
        [
            'key' => 'opensearchDashboards.dashboardAdmin.users|opensearchDashboards.dashboardAdmin.groups',
            'value' => '<string>',
        ],
        // ...
    ],
    'clientToken' => '<string>',
    'dataSources' => [
        [
            'dataSourceArn' => '<string>',
            'dataSourceDescription' => '<string>',
        ],
        // ...
    ],
    'iamIdentityCenterOptions' => [
        'enabled' => true || false,
        'iamIdentityCenterInstanceArn' => '<string>',
        'iamRoleForIdentityCenterApplicationArn' => '<string>',
    ],
    'name' => '<string>', // REQUIRED
    'tagList' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'appConfigs' => [
        [
            'key' => 'opensearchDashboards.dashboardAdmin.users|opensearchDashboards.dashboardAdmin.groups',
            'value' => '<string>',
        ],
        // ...
    ],
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'dataSources' => [
        [
            'dataSourceArn' => '<string>',
            'dataSourceDescription' => '<string>',
        ],
        // ...
    ],
    'iamIdentityCenterOptions' => [
        'enabled' => true || false,
        'iamIdentityCenterApplicationArn' => '<string>',
        'iamIdentityCenterInstanceArn' => '<string>',
        'iamRoleForIdentityCenterApplicationArn' => '<string>',
    ],
    'id' => '<string>',
    'name' => '<string>',
    'tagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException:

An error occurred because you don't have permissions to access the resource.

ConflictException:

An error occurred because the client attempts to remove a resource that is currently in use.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

CreateDomain

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

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

Parameter Syntax

$result = $client->createDomain([
    'AIMLOptions' => [
        'NaturalLanguageQueryGenerationOptions' => [
            'DesiredState' => 'ENABLED|DISABLED',
        ],
    ],
    'AccessPolicies' => '<string>',
    'AdvancedOptions' => ['<string>', ...],
    'AdvancedSecurityOptions' => [
        'AnonymousAuthEnabled' => true || false,
        'Enabled' => true || false,
        'InternalUserDatabaseEnabled' => true || false,
        'JWTOptions' => [
            'Enabled' => true || false,
            'PublicKey' => '<string>',
            'RolesKey' => '<string>',
            'SubjectKey' => '<string>',
        ],
        '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>,
            ],
            // ...
        ],
        'UseOffPeakWindow' => true || false,
    ],
    '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
        'MultiAZWithStandbyEnabled' => true || false,
        'NodeOptions' => [
            [
                'NodeConfig' => [
                    'Count' => <integer>,
                    'Enabled' => true || false,
                    'Type' => '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
                ],
                'NodeType' => 'coordinator',
            ],
            // ...
        ],
        '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|Policy-Min-TLS-1-2-PFS-2023-10',
    ],
    'DomainName' => '<string>', // REQUIRED
    'EBSOptions' => [
        'EBSEnabled' => true || false,
        'Iops' => <integer>,
        'Throughput' => <integer>,
        'VolumeSize' => <integer>,
        'VolumeType' => 'standard|gp2|io1|gp3',
    ],
    'EncryptionAtRestOptions' => [
        'Enabled' => true || false,
        'KmsKeyId' => '<string>',
    ],
    'EngineVersion' => '<string>',
    'IPAddressType' => 'ipv4|dualstack',
    'IdentityCenterOptions' => [
        'EnabledAPIAccess' => true || false,
        'IdentityCenterInstanceARN' => '<string>',
        'RolesKey' => 'GroupName|GroupId',
        'SubjectKey' => 'UserName|UserId|Email',
    ],
    'LogPublishingOptions' => [
        '<LogType>' => [
            'CloudWatchLogsLogGroupArn' => '<string>',
            'Enabled' => true || false,
        ],
        // ...
    ],
    'NodeToNodeEncryptionOptions' => [
        'Enabled' => true || false,
    ],
    'OffPeakWindowOptions' => [
        'Enabled' => true || false,
        'OffPeakWindow' => [
            'WindowStartTime' => [
                'Hours' => <integer>, // REQUIRED
                'Minutes' => <integer>, // REQUIRED
            ],
        ],
    ],
    'SnapshotOptions' => [
        'AutomatedSnapshotStartHour' => <integer>,
    ],
    'SoftwareUpdateOptions' => [
        'AutoSoftwareUpdateEnabled' => true || false,
    ],
    'TagList' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VPCOptions' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'DomainStatus' => [
        'AIMLOptions' => [
            'NaturalLanguageQueryGenerationOptions' => [
                'CurrentState' => 'NOT_ENABLED|ENABLE_COMPLETE|ENABLE_IN_PROGRESS|ENABLE_FAILED|DISABLE_COMPLETE|DISABLE_IN_PROGRESS|DISABLE_FAILED',
                'DesiredState' => 'ENABLED|DISABLED',
            ],
        ],
        'ARN' => '<string>',
        'AccessPolicies' => '<string>',
        'AdvancedOptions' => ['<string>', ...],
        'AdvancedSecurityOptions' => [
            'AnonymousAuthDisableDate' => <DateTime>,
            'AnonymousAuthEnabled' => true || false,
            'Enabled' => true || false,
            'InternalUserDatabaseEnabled' => true || false,
            'JWTOptions' => [
                'Enabled' => true || false,
                'PublicKey' => '<string>',
                'RolesKey' => '<string>',
                'SubjectKey' => '<string>',
            ],
            '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',
            'UseOffPeakWindow' => true || false,
        ],
        'ChangeProgressDetails' => [
            'ChangeId' => '<string>',
            'ConfigChangeStatus' => 'Pending|Initializing|Validating|ValidationFailed|ApplyingChanges|Completed|PendingUserInput|Cancelled',
            'InitiatedBy' => 'CUSTOMER|SERVICE',
            'LastUpdatedTime' => <DateTime>,
            'Message' => '<string>',
            'StartTime' => <DateTime>,
        ],
        '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
            'MultiAZWithStandbyEnabled' => true || false,
            'NodeOptions' => [
                [
                    'NodeConfig' => [
                        'Count' => <integer>,
                        'Enabled' => true || false,
                        'Type' => '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
                    ],
                    'NodeType' => 'coordinator',
                ],
                // ...
            ],
            '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|Policy-Min-TLS-1-2-PFS-2023-10',
        ],
        'DomainEndpointV2HostedZoneId' => '<string>',
        'DomainId' => '<string>',
        'DomainName' => '<string>',
        'DomainProcessingStatus' => 'Creating|Active|Modifying|UpgradingEngineVersion|UpdatingServiceSoftware|Isolated|Deleting',
        'EBSOptions' => [
            'EBSEnabled' => true || false,
            'Iops' => <integer>,
            'Throughput' => <integer>,
            'VolumeSize' => <integer>,
            'VolumeType' => 'standard|gp2|io1|gp3',
        ],
        'EncryptionAtRestOptions' => [
            'Enabled' => true || false,
            'KmsKeyId' => '<string>',
        ],
        'Endpoint' => '<string>',
        'EndpointV2' => '<string>',
        'Endpoints' => ['<string>', ...],
        'EngineVersion' => '<string>',
        'IPAddressType' => 'ipv4|dualstack',
        'IdentityCenterOptions' => [
            'EnabledAPIAccess' => true || false,
            'IdentityCenterApplicationARN' => '<string>',
            'IdentityCenterInstanceARN' => '<string>',
            'IdentityStoreId' => '<string>',
            'RolesKey' => 'GroupName|GroupId',
            'SubjectKey' => 'UserName|UserId|Email',
        ],
        'LogPublishingOptions' => [
            '<LogType>' => [
                'CloudWatchLogsLogGroupArn' => '<string>',
                'Enabled' => true || false,
            ],
            // ...
        ],
        'ModifyingProperties' => [
            [
                'ActiveValue' => '<string>',
                'Name' => '<string>',
                'PendingValue' => '<string>',
                'ValueType' => 'PLAIN_TEXT|STRINGIFIED_JSON',
            ],
            // ...
        ],
        'NodeToNodeEncryptionOptions' => [
            'Enabled' => true || false,
        ],
        'OffPeakWindowOptions' => [
            'Enabled' => true || false,
            'OffPeakWindow' => [
                'WindowStartTime' => [
                    'Hours' => <integer>,
                    'Minutes' => <integer>,
                ],
            ],
        ],
        '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>,
        ],
        'SoftwareUpdateOptions' => [
            'AutoSoftwareUpdateEnabled' => true || false,
        ],
        'UpgradeProcessing' => true || false,
        'VPCOptions' => [
            'AvailabilityZones' => ['<string>', ...],
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VPCId' => '<string>',
        ],
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

InvalidTypeException:

An exception for trying to create or access a sub-resource that's either invalid or not supported.

LimitExceededException:

An exception for trying to create more than the allowed number of resources or sub-resources.

ResourceAlreadyExistsException:

An exception for creating a resource that already exists.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

CreateOutboundConnection

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

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Parameter Syntax

$result = $client->createOutboundConnection([
    'ConnectionAlias' => '<string>', // REQUIRED
    'ConnectionMode' => 'DIRECT|VPC_ENDPOINT',
    'ConnectionProperties' => [
        'CrossClusterSearch' => [
            'SkipUnavailable' => 'ENABLED|DISABLED',
        ],
        'Endpoint' => '<string>',
    ],
    'LocalDomainInfo' => [ // REQUIRED
        'AWSDomainInformation' => [
            'DomainName' => '<string>', // REQUIRED
            'OwnerId' => '<string>',
            'Region' => '<string>',
        ],
    ],
    'RemoteDomainInfo' => [ // REQUIRED
        'AWSDomainInformation' => [
            'DomainName' => '<string>', // REQUIRED
            'OwnerId' => '<string>',
            'Region' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'ConnectionAlias' => '<string>',
    'ConnectionId' => '<string>',
    'ConnectionMode' => 'DIRECT|VPC_ENDPOINT',
    'ConnectionProperties' => [
        'CrossClusterSearch' => [
            'SkipUnavailable' => 'ENABLED|DISABLED',
        ],
        'Endpoint' => '<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

Errors

LimitExceededException:

An exception for trying to create more than the allowed number of resources or sub-resources.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceAlreadyExistsException:

An exception for creating a resource that already exists.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

CreatePackage

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

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

Parameter Syntax

$result = $client->createPackage([
    'EngineVersion' => '<string>',
    'PackageConfiguration' => [
        'ConfigurationRequirement' => 'REQUIRED|OPTIONAL|NONE', // REQUIRED
        'LicenseFilepath' => '<string>',
        'LicenseRequirement' => 'REQUIRED|OPTIONAL|NONE', // REQUIRED
        'RequiresRestartForConfigurationUpdate' => true || false,
    ],
    'PackageDescription' => '<string>',
    'PackageEncryptionOptions' => [
        'EncryptionEnabled' => true || false, // REQUIRED
        'KmsKeyIdentifier' => '<string>',
    ],
    'PackageName' => '<string>', // REQUIRED
    'PackageSource' => [ // REQUIRED
        'S3BucketName' => '<string>',
        'S3Key' => '<string>',
    ],
    'PackageType' => 'TXT-DICTIONARY|ZIP-PLUGIN|PACKAGE-LICENSE|PACKAGE-CONFIG', // REQUIRED
    'PackageVendingOptions' => [
        'VendingEnabled' => true || false, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'PackageDetails' => [
        'AllowListedUserList' => ['<string>', ...],
        'AvailablePackageConfiguration' => [
            'ConfigurationRequirement' => 'REQUIRED|OPTIONAL|NONE',
            'LicenseFilepath' => '<string>',
            'LicenseRequirement' => 'REQUIRED|OPTIONAL|NONE',
            'RequiresRestartForConfigurationUpdate' => true || false,
        ],
        'AvailablePackageVersion' => '<string>',
        'AvailablePluginProperties' => [
            'ClassName' => '<string>',
            'Description' => '<string>',
            'Name' => '<string>',
            'UncompressedSizeInBytes' => <integer>,
            'Version' => '<string>',
        ],
        'CreatedAt' => <DateTime>,
        'EngineVersion' => '<string>',
        'ErrorDetails' => [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        'LastUpdatedAt' => <DateTime>,
        'PackageDescription' => '<string>',
        'PackageEncryptionOptions' => [
            'EncryptionEnabled' => true || false,
            'KmsKeyIdentifier' => '<string>',
        ],
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageOwner' => '<string>',
        'PackageStatus' => 'COPYING|COPY_FAILED|VALIDATING|VALIDATION_FAILED|AVAILABLE|DELETING|DELETED|DELETE_FAILED',
        'PackageType' => 'TXT-DICTIONARY|ZIP-PLUGIN|PACKAGE-LICENSE|PACKAGE-CONFIG',
        'PackageVendingOptions' => [
            'VendingEnabled' => true || false,
        ],
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

LimitExceededException:

An exception for trying to create more than the allowed number of resources or sub-resources.

InvalidTypeException:

An exception for trying to create or access a sub-resource that's either invalid or not supported.

ResourceAlreadyExistsException:

An exception for creating a resource that already exists.

AccessDeniedException:

An error occurred because you don't have permissions to access the resource.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

CreateVpcEndpoint

$result = $client->createVpcEndpoint([/* ... */]);
$promise = $client->createVpcEndpointAsync([/* ... */]);

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Parameter Syntax

$result = $client->createVpcEndpoint([
    'ClientToken' => '<string>',
    'DomainArn' => '<string>', // REQUIRED
    'VpcOptions' => [ // REQUIRED
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'VpcEndpoint' => [
        'DomainArn' => '<string>',
        'Endpoint' => '<string>',
        'Status' => 'CREATING|CREATE_FAILED|ACTIVE|UPDATING|UPDATE_FAILED|DELETING|DELETE_FAILED',
        'VpcEndpointId' => '<string>',
        'VpcEndpointOwner' => '<string>',
        'VpcOptions' => [
            'AvailabilityZones' => ['<string>', ...],
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VPCId' => '<string>',
        ],
    ],
]

Result Details

Errors

ConflictException:

An error occurred because the client attempts to remove a resource that is currently in use.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

LimitExceededException:

An exception for trying to create more than the allowed number of resources or sub-resources.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

BaseException:

An error occurred while processing the request.

DeleteApplication

$result = $client->deleteApplication([/* ... */]);
$promise = $client->deleteApplicationAsync([/* ... */]);

Deletes an existing OpenSearch Application.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BaseException:

An error occurred while processing the request.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException:

An error occurred because you don't have permissions to access the resource.

ConflictException:

An error occurred because the client attempts to remove a resource that is currently in use.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

DeleteDataSource

$result = $client->deleteDataSource([/* ... */]);
$promise = $client->deleteDataSourceAsync([/* ... */]);

Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

DependencyFailureException:

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

DeleteDomain

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

Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DomainStatus' => [
        'AIMLOptions' => [
            'NaturalLanguageQueryGenerationOptions' => [
                'CurrentState' => 'NOT_ENABLED|ENABLE_COMPLETE|ENABLE_IN_PROGRESS|ENABLE_FAILED|DISABLE_COMPLETE|DISABLE_IN_PROGRESS|DISABLE_FAILED',
                'DesiredState' => 'ENABLED|DISABLED',
            ],
        ],
        'ARN' => '<string>',
        'AccessPolicies' => '<string>',
        'AdvancedOptions' => ['<string>', ...],
        'AdvancedSecurityOptions' => [
            'AnonymousAuthDisableDate' => <DateTime>,
            'AnonymousAuthEnabled' => true || false,
            'Enabled' => true || false,
            'InternalUserDatabaseEnabled' => true || false,
            'JWTOptions' => [
                'Enabled' => true || false,
                'PublicKey' => '<string>',
                'RolesKey' => '<string>',
                'SubjectKey' => '<string>',
            ],
            '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',
            'UseOffPeakWindow' => true || false,
        ],
        'ChangeProgressDetails' => [
            'ChangeId' => '<string>',
            'ConfigChangeStatus' => 'Pending|Initializing|Validating|ValidationFailed|ApplyingChanges|Completed|PendingUserInput|Cancelled',
            'InitiatedBy' => 'CUSTOMER|SERVICE',
            'LastUpdatedTime' => <DateTime>,
            'Message' => '<string>',
            'StartTime' => <DateTime>,
        ],
        '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
            'MultiAZWithStandbyEnabled' => true || false,
            'NodeOptions' => [
                [
                    'NodeConfig' => [
                        'Count' => <integer>,
                        'Enabled' => true || false,
                        'Type' => '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
                    ],
                    'NodeType' => 'coordinator',
                ],
                // ...
            ],
            '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|Policy-Min-TLS-1-2-PFS-2023-10',
        ],
        'DomainEndpointV2HostedZoneId' => '<string>',
        'DomainId' => '<string>',
        'DomainName' => '<string>',
        'DomainProcessingStatus' => 'Creating|Active|Modifying|UpgradingEngineVersion|UpdatingServiceSoftware|Isolated|Deleting',
        'EBSOptions' => [
            'EBSEnabled' => true || false,
            'Iops' => <integer>,
            'Throughput' => <integer>,
            'VolumeSize' => <integer>,
            'VolumeType' => 'standard|gp2|io1|gp3',
        ],
        'EncryptionAtRestOptions' => [
            'Enabled' => true || false,
            'KmsKeyId' => '<string>',
        ],
        'Endpoint' => '<string>',
        'EndpointV2' => '<string>',
        'Endpoints' => ['<string>', ...],
        'EngineVersion' => '<string>',
        'IPAddressType' => 'ipv4|dualstack',
        'IdentityCenterOptions' => [
            'EnabledAPIAccess' => true || false,
            'IdentityCenterApplicationARN' => '<string>',
            'IdentityCenterInstanceARN' => '<string>',
            'IdentityStoreId' => '<string>',
            'RolesKey' => 'GroupName|GroupId',
            'SubjectKey' => 'UserName|UserId|Email',
        ],
        'LogPublishingOptions' => [
            '<LogType>' => [
                'CloudWatchLogsLogGroupArn' => '<string>',
                'Enabled' => true || false,
            ],
            // ...
        ],
        'ModifyingProperties' => [
            [
                'ActiveValue' => '<string>',
                'Name' => '<string>',
                'PendingValue' => '<string>',
                'ValueType' => 'PLAIN_TEXT|STRINGIFIED_JSON',
            ],
            // ...
        ],
        'NodeToNodeEncryptionOptions' => [
            'Enabled' => true || false,
        ],
        'OffPeakWindowOptions' => [
            'Enabled' => true || false,
            'OffPeakWindow' => [
                'WindowStartTime' => [
                    'Hours' => <integer>,
                    'Minutes' => <integer>,
                ],
            ],
        ],
        '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>,
        ],
        'SoftwareUpdateOptions' => [
            'AutoSoftwareUpdateEnabled' => true || false,
        ],
        'UpgradeProcessing' => true || false,
        'VPCOptions' => [
            'AvailabilityZones' => ['<string>', ...],
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VPCId' => '<string>',
        ],
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DeleteInboundConnection

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

Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Connection' => [
        'ConnectionId' => '<string>',
        'ConnectionMode' => 'DIRECT|VPC_ENDPOINT',
        '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

Errors

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

DeleteOutboundConnection

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

Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Connection' => [
        'ConnectionAlias' => '<string>',
        'ConnectionId' => '<string>',
        'ConnectionMode' => 'DIRECT|VPC_ENDPOINT',
        'ConnectionProperties' => [
            'CrossClusterSearch' => [
                'SkipUnavailable' => 'ENABLED|DISABLED',
            ],
            'Endpoint' => '<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

Errors

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

DeletePackage

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

Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'PackageDetails' => [
        'AllowListedUserList' => ['<string>', ...],
        'AvailablePackageConfiguration' => [
            'ConfigurationRequirement' => 'REQUIRED|OPTIONAL|NONE',
            'LicenseFilepath' => '<string>',
            'LicenseRequirement' => 'REQUIRED|OPTIONAL|NONE',
            'RequiresRestartForConfigurationUpdate' => true || false,
        ],
        'AvailablePackageVersion' => '<string>',
        'AvailablePluginProperties' => [
            'ClassName' => '<string>',
            'Description' => '<string>',
            'Name' => '<string>',
            'UncompressedSizeInBytes' => <integer>,
            'Version' => '<string>',
        ],
        'CreatedAt' => <DateTime>,
        'EngineVersion' => '<string>',
        'ErrorDetails' => [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        'LastUpdatedAt' => <DateTime>,
        'PackageDescription' => '<string>',
        'PackageEncryptionOptions' => [
            'EncryptionEnabled' => true || false,
            'KmsKeyIdentifier' => '<string>',
        ],
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageOwner' => '<string>',
        'PackageStatus' => 'COPYING|COPY_FAILED|VALIDATING|VALIDATION_FAILED|AVAILABLE|DELETING|DELETED|DELETE_FAILED',
        'PackageType' => 'TXT-DICTIONARY|ZIP-PLUGIN|PACKAGE-LICENSE|PACKAGE-CONFIG',
        'PackageVendingOptions' => [
            'VendingEnabled' => true || false,
        ],
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException:

An error occurred because you don't have permissions to access the resource.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

ConflictException:

An error occurred because the client attempts to remove a resource that is currently in use.

DeleteVpcEndpoint

$result = $client->deleteVpcEndpoint([/* ... */]);
$promise = $client->deleteVpcEndpointAsync([/* ... */]);

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'VpcEndpointSummary' => [
        'DomainArn' => '<string>',
        'Status' => 'CREATING|CREATE_FAILED|ACTIVE|UPDATING|UPDATE_FAILED|DELETING|DELETE_FAILED',
        'VpcEndpointId' => '<string>',
        'VpcEndpointOwner' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

BaseException:

An error occurred while processing the request.

DescribeDomain

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

Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DomainStatus' => [
        'AIMLOptions' => [
            'NaturalLanguageQueryGenerationOptions' => [
                'CurrentState' => 'NOT_ENABLED|ENABLE_COMPLETE|ENABLE_IN_PROGRESS|ENABLE_FAILED|DISABLE_COMPLETE|DISABLE_IN_PROGRESS|DISABLE_FAILED',
                'DesiredState' => 'ENABLED|DISABLED',
            ],
        ],
        'ARN' => '<string>',
        'AccessPolicies' => '<string>',
        'AdvancedOptions' => ['<string>', ...],
        'AdvancedSecurityOptions' => [
            'AnonymousAuthDisableDate' => <DateTime>,
            'AnonymousAuthEnabled' => true || false,
            'Enabled' => true || false,
            'InternalUserDatabaseEnabled' => true || false,
            'JWTOptions' => [
                'Enabled' => true || false,
                'PublicKey' => '<string>',
                'RolesKey' => '<string>',
                'SubjectKey' => '<string>',
            ],
            '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',
            'UseOffPeakWindow' => true || false,
        ],
        'ChangeProgressDetails' => [
            'ChangeId' => '<string>',
            'ConfigChangeStatus' => 'Pending|Initializing|Validating|ValidationFailed|ApplyingChanges|Completed|PendingUserInput|Cancelled',
            'InitiatedBy' => 'CUSTOMER|SERVICE',
            'LastUpdatedTime' => <DateTime>,
            'Message' => '<string>',
            'StartTime' => <DateTime>,
        ],
        '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
            'MultiAZWithStandbyEnabled' => true || false,
            'NodeOptions' => [
                [
                    'NodeConfig' => [
                        'Count' => <integer>,
                        'Enabled' => true || false,
                        'Type' => '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
                    ],
                    'NodeType' => 'coordinator',
                ],
                // ...
            ],
            '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|Policy-Min-TLS-1-2-PFS-2023-10',
        ],
        'DomainEndpointV2HostedZoneId' => '<string>',
        'DomainId' => '<string>',
        'DomainName' => '<string>',
        'DomainProcessingStatus' => 'Creating|Active|Modifying|UpgradingEngineVersion|UpdatingServiceSoftware|Isolated|Deleting',
        'EBSOptions' => [
            'EBSEnabled' => true || false,
            'Iops' => <integer>,
            'Throughput' => <integer>,
            'VolumeSize' => <integer>,
            'VolumeType' => 'standard|gp2|io1|gp3',
        ],
        'EncryptionAtRestOptions' => [
            'Enabled' => true || false,
            'KmsKeyId' => '<string>',
        ],
        'Endpoint' => '<string>',
        'EndpointV2' => '<string>',
        'Endpoints' => ['<string>', ...],
        'EngineVersion' => '<string>',
        'IPAddressType' => 'ipv4|dualstack',
        'IdentityCenterOptions' => [
            'EnabledAPIAccess' => true || false,
            'IdentityCenterApplicationARN' => '<string>',
            'IdentityCenterInstanceARN' => '<string>',
            'IdentityStoreId' => '<string>',
            'RolesKey' => 'GroupName|GroupId',
            'SubjectKey' => 'UserName|UserId|Email',
        ],
        'LogPublishingOptions' => [
            '<LogType>' => [
                'CloudWatchLogsLogGroupArn' => '<string>',
                'Enabled' => true || false,
            ],
            // ...
        ],
        'ModifyingProperties' => [
            [
                'ActiveValue' => '<string>',
                'Name' => '<string>',
                'PendingValue' => '<string>',
                'ValueType' => 'PLAIN_TEXT|STRINGIFIED_JSON',
            ],
            // ...
        ],
        'NodeToNodeEncryptionOptions' => [
            'Enabled' => true || false,
        ],
        'OffPeakWindowOptions' => [
            'Enabled' => true || false,
            'OffPeakWindow' => [
                'WindowStartTime' => [
                    'Hours' => <integer>,
                    'Minutes' => <integer>,
                ],
            ],
        ],
        '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>,
        ],
        'SoftwareUpdateOptions' => [
            'AutoSoftwareUpdateEnabled' => true || false,
        ],
        'UpgradeProcessing' => true || false,
        'VPCOptions' => [
            'AvailabilityZones' => ['<string>', ...],
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VPCId' => '<string>',
        ],
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DescribeDomainAutoTunes

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

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

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

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DescribeDomainChangeProgress

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

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ChangeProgressStatus' => [
        'ChangeId' => '<string>',
        'ChangeProgressStages' => [
            [
                'Description' => '<string>',
                'LastUpdated' => <DateTime>,
                'Name' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'CompletedProperties' => ['<string>', ...],
        'ConfigChangeStatus' => 'Pending|Initializing|Validating|ValidationFailed|ApplyingChanges|Completed|PendingUserInput|Cancelled',
        'InitiatedBy' => 'CUSTOMER|SERVICE',
        'LastUpdatedTime' => <DateTime>,
        'PendingProperties' => ['<string>', ...],
        'StartTime' => <DateTime>,
        'Status' => 'PENDING|PROCESSING|COMPLETED|FAILED',
        'TotalNumberOfStages' => <integer>,
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DescribeDomainConfig

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

Returns the configuration of an Amazon OpenSearch Service domain.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DomainConfig' => [
        'AIMLOptions' => [
            'Options' => [
                'NaturalLanguageQueryGenerationOptions' => [
                    'CurrentState' => 'NOT_ENABLED|ENABLE_COMPLETE|ENABLE_IN_PROGRESS|ENABLE_FAILED|DISABLE_COMPLETE|DISABLE_IN_PROGRESS|DISABLE_FAILED',
                    'DesiredState' => 'ENABLED|DISABLED',
                ],
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        '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,
                'JWTOptions' => [
                    'Enabled' => true || false,
                    'PublicKey' => '<string>',
                    'RolesKey' => '<string>',
                    'SubjectKey' => '<string>',
                ],
                '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',
                'UseOffPeakWindow' => true || false,
            ],
            '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>',
            'ConfigChangeStatus' => 'Pending|Initializing|Validating|ValidationFailed|ApplyingChanges|Completed|PendingUserInput|Cancelled',
            'InitiatedBy' => 'CUSTOMER|SERVICE',
            'LastUpdatedTime' => <DateTime>,
            'Message' => '<string>',
            'StartTime' => <DateTime>,
        ],
        '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
                'MultiAZWithStandbyEnabled' => true || false,
                'NodeOptions' => [
                    [
                        'NodeConfig' => [
                            'Count' => <integer>,
                            'Enabled' => true || false,
                            'Type' => '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
                        ],
                        'NodeType' => 'coordinator',
                    ],
                    // ...
                ],
                '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|Policy-Min-TLS-1-2-PFS-2023-10',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'EBSOptions' => [
            'Options' => [
                'EBSEnabled' => true || false,
                'Iops' => <integer>,
                'Throughput' => <integer>,
                'VolumeSize' => <integer>,
                'VolumeType' => 'standard|gp2|io1|gp3',
            ],
            '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>,
            ],
        ],
        'IPAddressType' => [
            'Options' => 'ipv4|dualstack',
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'IdentityCenterOptions' => [
            'Options' => [
                'EnabledAPIAccess' => true || false,
                'IdentityCenterApplicationARN' => '<string>',
                'IdentityCenterInstanceARN' => '<string>',
                'IdentityStoreId' => '<string>',
                'RolesKey' => 'GroupName|GroupId',
                'SubjectKey' => 'UserName|UserId|Email',
            ],
            '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>,
            ],
        ],
        'ModifyingProperties' => [
            [
                'ActiveValue' => '<string>',
                'Name' => '<string>',
                'PendingValue' => '<string>',
                'ValueType' => 'PLAIN_TEXT|STRINGIFIED_JSON',
            ],
            // ...
        ],
        'NodeToNodeEncryptionOptions' => [
            'Options' => [
                'Enabled' => true || false,
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'OffPeakWindowOptions' => [
            'Options' => [
                'Enabled' => true || false,
                'OffPeakWindow' => [
                    'WindowStartTime' => [
                        'Hours' => <integer>,
                        'Minutes' => <integer>,
                    ],
                ],
            ],
            '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>,
            ],
        ],
        'SoftwareUpdateOptions' => [
            'Options' => [
                'AutoSoftwareUpdateEnabled' => true || false,
            ],
            '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

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DescribeDomainHealth

$result = $client->describeDomainHealth([/* ... */]);
$promise = $client->describeDomainHealthAsync([/* ... */]);

Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ActiveAvailabilityZoneCount' => '<string>',
    'AvailabilityZoneCount' => '<string>',
    'ClusterHealth' => 'Red|Yellow|Green|NotAvailable',
    'DataNodeCount' => '<string>',
    'DedicatedMaster' => true || false,
    'DomainState' => 'Active|Processing|NotAvailable',
    'EnvironmentInformation' => [
        [
            'AvailabilityZoneInformation' => [
                [
                    'AvailabilityZoneName' => '<string>',
                    'AvailableDataNodeCount' => '<string>',
                    'ConfiguredDataNodeCount' => '<string>',
                    'TotalShards' => '<string>',
                    'TotalUnAssignedShards' => '<string>',
                    'ZoneStatus' => 'Active|StandBy|NotAvailable',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'MasterEligibleNodeCount' => '<string>',
    'MasterNode' => 'Available|UnAvailable',
    'StandByAvailabilityZoneCount' => '<string>',
    'TotalShards' => '<string>',
    'TotalUnAssignedShards' => '<string>',
    'WarmNodeCount' => '<string>',
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

DescribeDomainNodes

$result = $client->describeDomainNodes([/* ... */]);
$promise = $client->describeDomainNodesAsync([/* ... */]);

Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DomainNodesStatusList' => [
        [
            'AvailabilityZone' => '<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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
            'NodeId' => '<string>',
            'NodeStatus' => 'Active|StandBy|NotAvailable',
            'NodeType' => 'Data|Ultrawarm|Master',
            'StorageSize' => '<string>',
            'StorageType' => '<string>',
            'StorageVolumeType' => 'standard|gp2|io1|gp3',
        ],
        // ...
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

DependencyFailureException:

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

DescribeDomains

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

Returns domain configuration information about the specified Amazon OpenSearch Service domains.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DomainStatusList' => [
        [
            'AIMLOptions' => [
                'NaturalLanguageQueryGenerationOptions' => [
                    'CurrentState' => 'NOT_ENABLED|ENABLE_COMPLETE|ENABLE_IN_PROGRESS|ENABLE_FAILED|DISABLE_COMPLETE|DISABLE_IN_PROGRESS|DISABLE_FAILED',
                    'DesiredState' => 'ENABLED|DISABLED',
                ],
            ],
            'ARN' => '<string>',
            'AccessPolicies' => '<string>',
            'AdvancedOptions' => ['<string>', ...],
            'AdvancedSecurityOptions' => [
                'AnonymousAuthDisableDate' => <DateTime>,
                'AnonymousAuthEnabled' => true || false,
                'Enabled' => true || false,
                'InternalUserDatabaseEnabled' => true || false,
                'JWTOptions' => [
                    'Enabled' => true || false,
                    'PublicKey' => '<string>',
                    'RolesKey' => '<string>',
                    'SubjectKey' => '<string>',
                ],
                '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',
                'UseOffPeakWindow' => true || false,
            ],
            'ChangeProgressDetails' => [
                'ChangeId' => '<string>',
                'ConfigChangeStatus' => 'Pending|Initializing|Validating|ValidationFailed|ApplyingChanges|Completed|PendingUserInput|Cancelled',
                'InitiatedBy' => 'CUSTOMER|SERVICE',
                'LastUpdatedTime' => <DateTime>,
                'Message' => '<string>',
                'StartTime' => <DateTime>,
            ],
            '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
                'MultiAZWithStandbyEnabled' => true || false,
                'NodeOptions' => [
                    [
                        'NodeConfig' => [
                            'Count' => <integer>,
                            'Enabled' => true || false,
                            'Type' => '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
                        ],
                        'NodeType' => 'coordinator',
                    ],
                    // ...
                ],
                '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|Policy-Min-TLS-1-2-PFS-2023-10',
            ],
            'DomainEndpointV2HostedZoneId' => '<string>',
            'DomainId' => '<string>',
            'DomainName' => '<string>',
            'DomainProcessingStatus' => 'Creating|Active|Modifying|UpgradingEngineVersion|UpdatingServiceSoftware|Isolated|Deleting',
            'EBSOptions' => [
                'EBSEnabled' => true || false,
                'Iops' => <integer>,
                'Throughput' => <integer>,
                'VolumeSize' => <integer>,
                'VolumeType' => 'standard|gp2|io1|gp3',
            ],
            'EncryptionAtRestOptions' => [
                'Enabled' => true || false,
                'KmsKeyId' => '<string>',
            ],
            'Endpoint' => '<string>',
            'EndpointV2' => '<string>',
            'Endpoints' => ['<string>', ...],
            'EngineVersion' => '<string>',
            'IPAddressType' => 'ipv4|dualstack',
            'IdentityCenterOptions' => [
                'EnabledAPIAccess' => true || false,
                'IdentityCenterApplicationARN' => '<string>',
                'IdentityCenterInstanceARN' => '<string>',
                'IdentityStoreId' => '<string>',
                'RolesKey' => 'GroupName|GroupId',
                'SubjectKey' => 'UserName|UserId|Email',
            ],
            'LogPublishingOptions' => [
                '<LogType>' => [
                    'CloudWatchLogsLogGroupArn' => '<string>',
                    'Enabled' => true || false,
                ],
                // ...
            ],
            'ModifyingProperties' => [
                [
                    'ActiveValue' => '<string>',
                    'Name' => '<string>',
                    'PendingValue' => '<string>',
                    'ValueType' => 'PLAIN_TEXT|STRINGIFIED_JSON',
                ],
                // ...
            ],
            'NodeToNodeEncryptionOptions' => [
                'Enabled' => true || false,
            ],
            'OffPeakWindowOptions' => [
                'Enabled' => true || false,
                'OffPeakWindow' => [
                    'WindowStartTime' => [
                        'Hours' => <integer>,
                        'Minutes' => <integer>,
                    ],
                ],
            ],
            '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>,
            ],
            'SoftwareUpdateOptions' => [
                'AutoSoftwareUpdateEnabled' => true || false,
            ],
            'UpgradeProcessing' => true || false,
            'VPCOptions' => [
                'AvailabilityZones' => ['<string>', ...],
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
                'VPCId' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DescribeDryRunProgress

$result = $client->describeDryRunProgress([/* ... */]);
$promise = $client->describeDryRunProgressAsync([/* ... */]);

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

Parameter Syntax

$result = $client->describeDryRunProgress([
    'DomainName' => '<string>', // REQUIRED
    'DryRunId' => '<string>',
    'LoadDryRunConfig' => true || false,
]);

Parameter Details

Result Syntax

[
    'DryRunConfig' => [
        'AIMLOptions' => [
            'NaturalLanguageQueryGenerationOptions' => [
                'CurrentState' => 'NOT_ENABLED|ENABLE_COMPLETE|ENABLE_IN_PROGRESS|ENABLE_FAILED|DISABLE_COMPLETE|DISABLE_IN_PROGRESS|DISABLE_FAILED',
                'DesiredState' => 'ENABLED|DISABLED',
            ],
        ],
        'ARN' => '<string>',
        'AccessPolicies' => '<string>',
        'AdvancedOptions' => ['<string>', ...],
        'AdvancedSecurityOptions' => [
            'AnonymousAuthDisableDate' => <DateTime>,
            'AnonymousAuthEnabled' => true || false,
            'Enabled' => true || false,
            'InternalUserDatabaseEnabled' => true || false,
            'JWTOptions' => [
                'Enabled' => true || false,
                'PublicKey' => '<string>',
                'RolesKey' => '<string>',
                'SubjectKey' => '<string>',
            ],
            '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',
            'UseOffPeakWindow' => true || false,
        ],
        'ChangeProgressDetails' => [
            'ChangeId' => '<string>',
            'ConfigChangeStatus' => 'Pending|Initializing|Validating|ValidationFailed|ApplyingChanges|Completed|PendingUserInput|Cancelled',
            'InitiatedBy' => 'CUSTOMER|SERVICE',
            'LastUpdatedTime' => <DateTime>,
            'Message' => '<string>',
            'StartTime' => <DateTime>,
        ],
        '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
            'MultiAZWithStandbyEnabled' => true || false,
            'NodeOptions' => [
                [
                    'NodeConfig' => [
                        'Count' => <integer>,
                        'Enabled' => true || false,
                        'Type' => '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
                    ],
                    'NodeType' => 'coordinator',
                ],
                // ...
            ],
            '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|Policy-Min-TLS-1-2-PFS-2023-10',
        ],
        'DomainEndpointV2HostedZoneId' => '<string>',
        'DomainId' => '<string>',
        'DomainName' => '<string>',
        'DomainProcessingStatus' => 'Creating|Active|Modifying|UpgradingEngineVersion|UpdatingServiceSoftware|Isolated|Deleting',
        'EBSOptions' => [
            'EBSEnabled' => true || false,
            'Iops' => <integer>,
            'Throughput' => <integer>,
            'VolumeSize' => <integer>,
            'VolumeType' => 'standard|gp2|io1|gp3',
        ],
        'EncryptionAtRestOptions' => [
            'Enabled' => true || false,
            'KmsKeyId' => '<string>',
        ],
        'Endpoint' => '<string>',
        'EndpointV2' => '<string>',
        'Endpoints' => ['<string>', ...],
        'EngineVersion' => '<string>',
        'IPAddressType' => 'ipv4|dualstack',
        'IdentityCenterOptions' => [
            'EnabledAPIAccess' => true || false,
            'IdentityCenterApplicationARN' => '<string>',
            'IdentityCenterInstanceARN' => '<string>',
            'IdentityStoreId' => '<string>',
            'RolesKey' => 'GroupName|GroupId',
            'SubjectKey' => 'UserName|UserId|Email',
        ],
        'LogPublishingOptions' => [
            '<LogType>' => [
                'CloudWatchLogsLogGroupArn' => '<string>',
                'Enabled' => true || false,
            ],
            // ...
        ],
        'ModifyingProperties' => [
            [
                'ActiveValue' => '<string>',
                'Name' => '<string>',
                'PendingValue' => '<string>',
                'ValueType' => 'PLAIN_TEXT|STRINGIFIED_JSON',
            ],
            // ...
        ],
        'NodeToNodeEncryptionOptions' => [
            'Enabled' => true || false,
        ],
        'OffPeakWindowOptions' => [
            'Enabled' => true || false,
            'OffPeakWindow' => [
                'WindowStartTime' => [
                    'Hours' => <integer>,
                    'Minutes' => <integer>,
                ],
            ],
        ],
        '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>,
        ],
        'SoftwareUpdateOptions' => [
            'AutoSoftwareUpdateEnabled' => true || false,
        ],
        'UpgradeProcessing' => true || false,
        'VPCOptions' => [
            'AvailabilityZones' => ['<string>', ...],
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VPCId' => '<string>',
        ],
    ],
    'DryRunProgressStatus' => [
        'CreationDate' => '<string>',
        'DryRunId' => '<string>',
        'DryRunStatus' => '<string>',
        'UpdateDate' => '<string>',
        'ValidationFailures' => [
            [
                'Code' => '<string>',
                'Message' => '<string>',
            ],
            // ...
        ],
    ],
    'DryRunResults' => [
        'DeploymentType' => '<string>',
        'Message' => '<string>',
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

DescribeInboundConnections

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

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Connections' => [
        [
            'ConnectionId' => '<string>',
            'ConnectionMode' => 'DIRECT|VPC_ENDPOINT',
            '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

Errors

InvalidPaginationTokenException:

Request processing failed because you provided an invalid pagination token.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

DescribeInstanceTypeLimits

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

Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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

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

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

InvalidTypeException:

An exception for trying to create or access a sub-resource that's either invalid or not supported.

LimitExceededException:

An exception for trying to create more than the allowed number of resources or sub-resources.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DescribeOutboundConnections

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

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Connections' => [
        [
            'ConnectionAlias' => '<string>',
            'ConnectionId' => '<string>',
            'ConnectionMode' => 'DIRECT|VPC_ENDPOINT',
            'ConnectionProperties' => [
                'CrossClusterSearch' => [
                    'SkipUnavailable' => 'ENABLED|DISABLED',
                ],
                'Endpoint' => '<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

Errors

InvalidPaginationTokenException:

Request processing failed because you provided an invalid pagination token.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

DescribePackages

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

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PackageDetailsList' => [
        [
            'AllowListedUserList' => ['<string>', ...],
            'AvailablePackageConfiguration' => [
                'ConfigurationRequirement' => 'REQUIRED|OPTIONAL|NONE',
                'LicenseFilepath' => '<string>',
                'LicenseRequirement' => 'REQUIRED|OPTIONAL|NONE',
                'RequiresRestartForConfigurationUpdate' => true || false,
            ],
            'AvailablePackageVersion' => '<string>',
            'AvailablePluginProperties' => [
                'ClassName' => '<string>',
                'Description' => '<string>',
                'Name' => '<string>',
                'UncompressedSizeInBytes' => <integer>,
                'Version' => '<string>',
            ],
            'CreatedAt' => <DateTime>,
            'EngineVersion' => '<string>',
            'ErrorDetails' => [
                'ErrorMessage' => '<string>',
                'ErrorType' => '<string>',
            ],
            'LastUpdatedAt' => <DateTime>,
            'PackageDescription' => '<string>',
            'PackageEncryptionOptions' => [
                'EncryptionEnabled' => true || false,
                'KmsKeyIdentifier' => '<string>',
            ],
            'PackageID' => '<string>',
            'PackageName' => '<string>',
            'PackageOwner' => '<string>',
            'PackageStatus' => 'COPYING|COPY_FAILED|VALIDATING|VALIDATION_FAILED|AVAILABLE|DELETING|DELETED|DELETE_FAILED',
            'PackageType' => 'TXT-DICTIONARY|ZIP-PLUGIN|PACKAGE-LICENSE|PACKAGE-CONFIG',
            'PackageVendingOptions' => [
                'VendingEnabled' => true || false,
            ],
        ],
        // ...
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException:

An error occurred because you don't have permissions to access the resource.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DescribeReservedInstanceOfferings

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

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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

Errors

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

DescribeReservedInstances

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

Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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

Errors

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

DescribeVpcEndpoints

$result = $client->describeVpcEndpoints([/* ... */]);
$promise = $client->describeVpcEndpointsAsync([/* ... */]);

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'VpcEndpointErrors' => [
        [
            'ErrorCode' => 'ENDPOINT_NOT_FOUND|SERVER_ERROR',
            'ErrorMessage' => '<string>',
            'VpcEndpointId' => '<string>',
        ],
        // ...
    ],
    'VpcEndpoints' => [
        [
            'DomainArn' => '<string>',
            'Endpoint' => '<string>',
            'Status' => 'CREATING|CREATE_FAILED|ACTIVE|UPDATING|UPDATE_FAILED|DELETING|DELETE_FAILED',
            'VpcEndpointId' => '<string>',
            'VpcEndpointOwner' => '<string>',
            'VpcOptions' => [
                'AvailabilityZones' => ['<string>', ...],
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
                'VPCId' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

BaseException:

An error occurred while processing the request.

DissociatePackage

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

Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DomainPackageDetails' => [
        'AssociationConfiguration' => [
            'KeyStoreAccessOption' => [
                'KeyAccessRoleArn' => '<string>',
                'KeyStoreAccessEnabled' => true || false,
            ],
        ],
        'DomainName' => '<string>',
        'DomainPackageStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ACTIVE|DISSOCIATING|DISSOCIATION_FAILED',
        'ErrorDetails' => [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        'LastUpdated' => <DateTime>,
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageType' => 'TXT-DICTIONARY|ZIP-PLUGIN|PACKAGE-LICENSE|PACKAGE-CONFIG',
        'PackageVersion' => '<string>',
        'PrerequisitePackageIDList' => ['<string>', ...],
        'ReferencePath' => '<string>',
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException:

An error occurred because you don't have permissions to access the resource.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

ConflictException:

An error occurred because the client attempts to remove a resource that is currently in use.

DissociatePackages

$result = $client->dissociatePackages([/* ... */]);
$promise = $client->dissociatePackagesAsync([/* ... */]);

Dissociates multiple packages from a domain simulatneously.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DomainPackageDetailsList' => [
        [
            'AssociationConfiguration' => [
                'KeyStoreAccessOption' => [
                    'KeyAccessRoleArn' => '<string>',
                    'KeyStoreAccessEnabled' => true || false,
                ],
            ],
            'DomainName' => '<string>',
            'DomainPackageStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ACTIVE|DISSOCIATING|DISSOCIATION_FAILED',
            'ErrorDetails' => [
                'ErrorMessage' => '<string>',
                'ErrorType' => '<string>',
            ],
            'LastUpdated' => <DateTime>,
            'PackageID' => '<string>',
            'PackageName' => '<string>',
            'PackageType' => 'TXT-DICTIONARY|ZIP-PLUGIN|PACKAGE-LICENSE|PACKAGE-CONFIG',
            'PackageVersion' => '<string>',
            'PrerequisitePackageIDList' => ['<string>', ...],
            'ReferencePath' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

ConflictException:

An error occurred because the client attempts to remove a resource that is currently in use.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

GetApplication

$result = $client->getApplication([/* ... */]);
$promise = $client->getApplicationAsync([/* ... */]);

Check the configuration and status of an existing OpenSearch Application.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'appConfigs' => [
        [
            'key' => 'opensearchDashboards.dashboardAdmin.users|opensearchDashboards.dashboardAdmin.groups',
            'value' => '<string>',
        ],
        // ...
    ],
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'dataSources' => [
        [
            'dataSourceArn' => '<string>',
            'dataSourceDescription' => '<string>',
        ],
        // ...
    ],
    'endpoint' => '<string>',
    'iamIdentityCenterOptions' => [
        'enabled' => true || false,
        'iamIdentityCenterApplicationArn' => '<string>',
        'iamIdentityCenterInstanceArn' => '<string>',
        'iamRoleForIdentityCenterApplicationArn' => '<string>',
    ],
    'id' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'status' => 'CREATING|UPDATING|DELETING|ACTIVE|FAILED',
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException:

An error occurred because you don't have permissions to access the resource.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

GetCompatibleVersions

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

Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BaseException:

An error occurred while processing the request.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

GetDataSource

$result = $client->getDataSource([/* ... */]);
$promise = $client->getDataSourceAsync([/* ... */]);

Retrieves information about a direct query data source.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DataSourceType' => [
        'S3GlueDataCatalog' => [
            'RoleArn' => '<string>',
        ],
    ],
    'Description' => '<string>',
    'Name' => '<string>',
    'Status' => 'ACTIVE|DISABLED',
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

DependencyFailureException:

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

GetDomainMaintenanceStatus

$result = $client->getDomainMaintenanceStatus([/* ... */]);
$promise = $client->getDomainMaintenanceStatusAsync([/* ... */]);

The status of the maintenance action.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Action' => 'REBOOT_NODE|RESTART_SEARCH_PROCESS|RESTART_DASHBOARD',
    'CreatedAt' => <DateTime>,
    'NodeId' => '<string>',
    'Status' => 'PENDING|IN_PROGRESS|COMPLETED|FAILED|TIMED_OUT',
    'StatusMessage' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

GetPackageVersionHistory

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

Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PackageID' => '<string>',
    'PackageVersionHistoryList' => [
        [
            'CommitMessage' => '<string>',
            'CreatedAt' => <DateTime>,
            'PackageConfiguration' => [
                'ConfigurationRequirement' => 'REQUIRED|OPTIONAL|NONE',
                'LicenseFilepath' => '<string>',
                'LicenseRequirement' => 'REQUIRED|OPTIONAL|NONE',
                'RequiresRestartForConfigurationUpdate' => true || false,
            ],
            'PackageVersion' => '<string>',
            'PluginProperties' => [
                'ClassName' => '<string>',
                'Description' => '<string>',
                'Name' => '<string>',
                'UncompressedSizeInBytes' => <integer>,
                'Version' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException:

An error occurred because you don't have permissions to access the resource.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

GetUpgradeHistory

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

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

Parameter Syntax

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

Parameter Details

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

Errors

BaseException:

An error occurred while processing the request.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

GetUpgradeStatus

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

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BaseException:

An error occurred while processing the request.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ListApplications

$result = $client->listApplications([/* ... */]);
$promise = $client->listApplicationsAsync([/* ... */]);

List all OpenSearch Applications under your account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ApplicationSummaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'endpoint' => '<string>',
            'id' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'status' => 'CREATING|UPDATING|DELETING|ACTIVE|FAILED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException:

An error occurred because you don't have permissions to access the resource.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

ListDataSources

$result = $client->listDataSources([/* ... */]);
$promise = $client->listDataSourcesAsync([/* ... */]);

Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DataSources' => [
        [
            'DataSourceType' => [
                'S3GlueDataCatalog' => [
                    'RoleArn' => '<string>',
                ],
            ],
            'Description' => '<string>',
            'Name' => '<string>',
            'Status' => 'ACTIVE|DISABLED',
        ],
        // ...
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

DependencyFailureException:

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

ListDomainMaintenances

$result = $client->listDomainMaintenances([/* ... */]);
$promise = $client->listDomainMaintenancesAsync([/* ... */]);

A list of maintenance actions for the domain.

Parameter Syntax

$result = $client->listDomainMaintenances([
    'Action' => 'REBOOT_NODE|RESTART_SEARCH_PROCESS|RESTART_DASHBOARD',
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Status' => 'PENDING|IN_PROGRESS|COMPLETED|FAILED|TIMED_OUT',
]);

Parameter Details

Result Syntax

[
    'DomainMaintenances' => [
        [
            'Action' => 'REBOOT_NODE|RESTART_SEARCH_PROCESS|RESTART_DASHBOARD',
            'CreatedAt' => <DateTime>,
            'DomainName' => '<string>',
            'MaintenanceId' => '<string>',
            'NodeId' => '<string>',
            'Status' => 'PENDING|IN_PROGRESS|COMPLETED|FAILED|TIMED_OUT',
            'StatusMessage' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

ListDomainNames

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

Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BaseException:

An error occurred while processing the request.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

ListDomainsForPackage

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

Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DomainPackageDetailsList' => [
        [
            'AssociationConfiguration' => [
                'KeyStoreAccessOption' => [
                    'KeyAccessRoleArn' => '<string>',
                    'KeyStoreAccessEnabled' => true || false,
                ],
            ],
            'DomainName' => '<string>',
            'DomainPackageStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ACTIVE|DISSOCIATING|DISSOCIATION_FAILED',
            'ErrorDetails' => [
                'ErrorMessage' => '<string>',
                'ErrorType' => '<string>',
            ],
            'LastUpdated' => <DateTime>,
            'PackageID' => '<string>',
            'PackageName' => '<string>',
            'PackageType' => 'TXT-DICTIONARY|ZIP-PLUGIN|PACKAGE-LICENSE|PACKAGE-CONFIG',
            'PackageVersion' => '<string>',
            'PrerequisitePackageIDList' => ['<string>', ...],
            'ReferencePath' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException:

An error occurred because you don't have permissions to access the resource.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

ListInstanceTypeDetails

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

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'InstanceTypeDetails' => [
        [
            'AdvancedSecurityEnabled' => true || false,
            'AppLogsEnabled' => true || false,
            'AvailabilityZones' => ['<string>', ...],
            '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

ListPackagesForDomain

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

Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DomainPackageDetailsList' => [
        [
            'AssociationConfiguration' => [
                'KeyStoreAccessOption' => [
                    'KeyAccessRoleArn' => '<string>',
                    'KeyStoreAccessEnabled' => true || false,
                ],
            ],
            'DomainName' => '<string>',
            'DomainPackageStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ACTIVE|DISSOCIATING|DISSOCIATION_FAILED',
            'ErrorDetails' => [
                'ErrorMessage' => '<string>',
                'ErrorType' => '<string>',
            ],
            'LastUpdated' => <DateTime>,
            'PackageID' => '<string>',
            'PackageName' => '<string>',
            'PackageType' => 'TXT-DICTIONARY|ZIP-PLUGIN|PACKAGE-LICENSE|PACKAGE-CONFIG',
            'PackageVersion' => '<string>',
            'PrerequisitePackageIDList' => ['<string>', ...],
            'ReferencePath' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException:

An error occurred because you don't have permissions to access the resource.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

ListScheduledActions

$result = $client->listScheduledActions([/* ... */]);
$promise = $client->listScheduledActionsAsync([/* ... */]);

Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ScheduledActions' => [
        [
            'Cancellable' => true || false,
            'Description' => '<string>',
            'Id' => '<string>',
            'Mandatory' => true || false,
            'ScheduledBy' => 'CUSTOMER|SYSTEM',
            'ScheduledTime' => <integer>,
            'Severity' => 'HIGH|MEDIUM|LOW',
            'Status' => 'PENDING_UPDATE|IN_PROGRESS|FAILED|COMPLETED|NOT_ELIGIBLE|ELIGIBLE',
            'Type' => 'SERVICE_SOFTWARE_UPDATE|JVM_HEAP_SIZE_TUNING|JVM_YOUNG_GEN_TUNING',
        ],
        // ...
    ],
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

InvalidPaginationTokenException:

Request processing failed because you provided an invalid pagination token.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

ListTags

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

Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BaseException:

An error occurred while processing the request.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ListVersions

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

Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

ListVpcEndpointAccess

$result = $client->listVpcEndpointAccess([/* ... */]);
$promise = $client->listVpcEndpointAccessAsync([/* ... */]);

Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AuthorizedPrincipalList' => [
        [
            'Principal' => '<string>',
            'PrincipalType' => 'AWS_ACCOUNT|AWS_SERVICE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

BaseException:

An error occurred while processing the request.

ListVpcEndpoints

$result = $client->listVpcEndpoints([/* ... */]);
$promise = $client->listVpcEndpointsAsync([/* ... */]);

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'VpcEndpointSummaryList' => [
        [
            'DomainArn' => '<string>',
            'Status' => 'CREATING|CREATE_FAILED|ACTIVE|UPDATING|UPDATE_FAILED|DELETING|DELETE_FAILED',
            'VpcEndpointId' => '<string>',
            'VpcEndpointOwner' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

BaseException:

An error occurred while processing the request.

ListVpcEndpointsForDomain

$result = $client->listVpcEndpointsForDomain([/* ... */]);
$promise = $client->listVpcEndpointsForDomainAsync([/* ... */]);

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'VpcEndpointSummaryList' => [
        [
            'DomainArn' => '<string>',
            'Status' => 'CREATING|CREATE_FAILED|ACTIVE|UPDATING|UPDATE_FAILED|DELETING|DELETE_FAILED',
            'VpcEndpointId' => '<string>',
            'VpcEndpointOwner' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

BaseException:

An error occurred while processing the request.

PurchaseReservedInstanceOffering

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

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ResourceAlreadyExistsException:

An exception for creating a resource that already exists.

LimitExceededException:

An exception for trying to create more than the allowed number of resources or sub-resources.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

RejectInboundConnection

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Connection' => [
        'ConnectionId' => '<string>',
        'ConnectionMode' => 'DIRECT|VPC_ENDPOINT',
        '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

Errors

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

RemoveTags

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

Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BaseException:

An error occurred while processing the request.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

RevokeVpcEndpointAccess

$result = $client->revokeVpcEndpointAccess([/* ... */]);
$promise = $client->revokeVpcEndpointAccessAsync([/* ... */]);

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

Parameter Syntax

$result = $client->revokeVpcEndpointAccess([
    'Account' => '<string>',
    'DomainName' => '<string>', // REQUIRED
    'Service' => 'application.opensearchservice.amazonaws.com',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

BaseException:

An error occurred while processing the request.

StartDomainMaintenance

$result = $client->startDomainMaintenance([/* ... */]);
$promise = $client->startDomainMaintenanceAsync([/* ... */]);

Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.

Parameter Syntax

$result = $client->startDomainMaintenance([
    'Action' => 'REBOOT_NODE|RESTART_SEARCH_PROCESS|RESTART_DASHBOARD', // REQUIRED
    'DomainName' => '<string>', // REQUIRED
    'NodeId' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

StartServiceSoftwareUpdate

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

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

Parameter Syntax

$result = $client->startServiceSoftwareUpdate([
    'DesiredStartTime' => <integer>,
    'DomainName' => '<string>', // REQUIRED
    'ScheduleAt' => 'NOW|TIMESTAMP|OFF_PEAK_WINDOW',
]);

Parameter Details

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

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

UpdateApplication

$result = $client->updateApplication([/* ... */]);
$promise = $client->updateApplicationAsync([/* ... */]);

Update the OpenSearch Application.

Parameter Syntax

$result = $client->updateApplication([
    'appConfigs' => [
        [
            'key' => 'opensearchDashboards.dashboardAdmin.users|opensearchDashboards.dashboardAdmin.groups',
            'value' => '<string>',
        ],
        // ...
    ],
    'dataSources' => [
        [
            'dataSourceArn' => '<string>',
            'dataSourceDescription' => '<string>',
        ],
        // ...
    ],
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appConfigs' => [
        [
            'key' => 'opensearchDashboards.dashboardAdmin.users|opensearchDashboards.dashboardAdmin.groups',
            'value' => '<string>',
        ],
        // ...
    ],
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'dataSources' => [
        [
            'dataSourceArn' => '<string>',
            'dataSourceDescription' => '<string>',
        ],
        // ...
    ],
    'iamIdentityCenterOptions' => [
        'enabled' => true || false,
        'iamIdentityCenterApplicationArn' => '<string>',
        'iamIdentityCenterInstanceArn' => '<string>',
        'iamRoleForIdentityCenterApplicationArn' => '<string>',
    ],
    'id' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
]

Result Details

Errors

BaseException:

An error occurred while processing the request.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException:

An error occurred because you don't have permissions to access the resource.

ConflictException:

An error occurred because the client attempts to remove a resource that is currently in use.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

UpdateDataSource

$result = $client->updateDataSource([/* ... */]);
$promise = $client->updateDataSourceAsync([/* ... */]);

Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.

Parameter Syntax

$result = $client->updateDataSource([
    'DataSourceType' => [ // REQUIRED
        'S3GlueDataCatalog' => [
            'RoleArn' => '<string>',
        ],
    ],
    'Description' => '<string>',
    'DomainName' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Status' => 'ACTIVE|DISABLED',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BaseException:

An error occurred while processing the request.

InternalException:

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException:

An exception for accessing or deleting a resource that doesn't exist.

ValidationException:

An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException:

An error occured because the client wanted to access an unsupported operation.

DependencyFailureException:

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

UpdateDomainConfig

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

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

Parameter Syntax

$result = $client->updateDomainConfig([
    'AIMLOptions' => [
        'NaturalLanguageQueryGenerationOptions' => [
            'DesiredState' => 'ENABLED|DISABLED',
        ],
    ],
    'AccessPolicies' => '<string>',
    'AdvancedOptions' => ['<string>', ...],
    'AdvancedSecurityOptions' => [
        'AnonymousAuthEnabled' => true || false,
        'Enabled' => true || false,
        'InternalUserDatabaseEnabled' => true || false,
        'JWTOptions' => [
            'Enabled' => true || false,
            'PublicKey' => '<string>',
            'RolesKey' => '<string>',
            'SubjectKey' => '<string>',
        ],
        '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',
        'UseOffPeakWindow' => true || false,
    ],
    '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
        'MultiAZWithStandbyEnabled' => true || false,
        'NodeOptions' => [
            [
                'NodeConfig' => [
                    'Count' => <integer>,
                    'Enabled' => true || false,
                    'Type' => '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
                ],
                'NodeType' => 'coordinator',
            ],
            // ...
        ],
        '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|Policy-Min-TLS-1-2-PFS-2023-10',
    ],
    'DomainName' => '<string>', // REQUIRED
    'DryRun' => true || false,
    'DryRunMode' => 'Basic|Verbose',
    'EBSOptions' => [
        'EBSEnabled' => true || false,
        'Iops' => <integer>,
        'Throughput' => <integer>,
        'VolumeSize' => <integer>,
        'VolumeType' => 'standard|gp2|io1|gp3',
    ],
    'EncryptionAtRestOptions' => [
        'Enabled' => true || false,
        'KmsKeyId' => '<string>',
    ],
    'IPAddressType' => 'ipv4|dualstack',
    'IdentityCenterOptions' => [
        'EnabledAPIAccess' => true || false,
        'IdentityCenterInstanceARN' => '<string>',
        'RolesKey' => 'GroupName|GroupId',
        'SubjectKey' => 'UserName|UserId|Email',
    ],
    'LogPublishingOptions' => [
        '<LogType>' => [
            'CloudWatchLogsLogGroupArn' => '<string>',
            'Enabled' => true || false,
        ],
        // ...
    ],
    'NodeToNodeEncryptionOptions' => [
        'Enabled' => true || false,
    ],
    'OffPeakWindowOptions' => [
        'Enabled' => true || false,
        'OffPeakWindow' => [
            'WindowStartTime' => [
                'Hours' => <integer>, // REQUIRED
                'Minutes' => <integer>, // REQUIRED
            ],
        ],
    ],
    'SnapshotOptions' => [
        'AutomatedSnapshotStartHour' => <integer>,
    ],
    'SoftwareUpdateOptions' => [
        'AutoSoftwareUpdateEnabled' => true || false,
    ],
    'VPCOptions' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'DomainConfig' => [
        'AIMLOptions' => [
            'Options' => [
                'NaturalLanguageQueryGenerationOptions' => [
                    'CurrentState' => 'NOT_ENABLED|ENABLE_COMPLETE|ENABLE_IN_PROGRESS|ENABLE_FAILED|DISABLE_COMPLETE|DISABLE_IN_PROGRESS|DISABLE_FAILED',
                    'DesiredState' => 'ENABLED|DISABLED',
                ],
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        '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,
                'JWTOptions' => [
                    'Enabled' => true || false,
                    'PublicKey' => '<string>',
                    'RolesKey' => '<string>',
                    'SubjectKey' => '<string>',
                ],
                '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',
                'UseOffPeakWindow' => true || false,
            ],
            '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>',
            'ConfigChangeStatus' => 'Pending|Initializing|Validating|ValidationFailed|ApplyingChanges|Completed|PendingUserInput|Cancelled',
            'InitiatedBy' => 'CUSTOMER|SERVICE',
            'LastUpdatedTime' => <DateTime>,
            'Message' => '<string>',
            'StartTime' => <DateTime>,
        ],
        '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
                'MultiAZWithStandbyEnabled' => true || false,
                'NodeOptions' => [
                    [
                        'NodeConfig' => [
                            'Count' => <integer>,
                            'Enabled' => true || false,
                            'Type' => '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|or1.medium.search|or1.large.search|or1.xlarge.search|or1.2xlarge.search|or1.4xlarge.search|or1.8xlarge.search|or1.12xlarge.search|or1.16xlarge.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',
                        ],
                        'NodeType' => 'coordinator',
                    ],
                    // ...
                ],
                '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|Policy-Min-TLS-1-2-PFS-2023-10',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'EBSOptions' => [
            'Options' => [
                'EBSEnabled' => true || false,
                'Iops' => <integer>,
                'Throughput' => <integer>,
                'VolumeSize' => <integer>,
                'VolumeType' => 'standard|gp2|io1|gp3',
            ],
            '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>,
            ],
        ],
        'IPAddressType' => [
            'Options' => 'ipv4|dualstack',
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'IdentityCenterOptions' => [
            'Options' => [
                'EnabledAPIAccess' => true || false,
                'IdentityCenterApplicationARN' => '<string>',
                'IdentityCenterInstanceARN' => '<string>',
                'IdentityStoreId' => '<string>',
                'RolesKey' => 'GroupName|GroupId',
                'SubjectKey' => 'UserName|UserId|Email',
            ],
            '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>,
            ],
        ],
        'ModifyingProperties' => [
            [
                'ActiveValue' => '<string>',
                'Name' => '<string>',
                'PendingValue' => '<string>',
                'ValueType' => 'PLAIN_TEXT|STRINGIFIED_JSON',
            ],
            // ...
        ],
        'NodeToNodeEncryptionOptions' => [
            'Options' => [
                'Enabled' => true || false,
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'OffPeakWindowOptions' => [
            'Options' => [
                'Enabled' => true || false,
                'OffPeakWindow' => [
                    'WindowStartTime' => [
                        'Hours' => <integer>,
                        'Minutes' => <integer>,
                    ],
                ],
            ],
            '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>,
            ],
        ],
        'SoftwareUpdateOptions' => [
            'Options' => [
                'AutoSoftwareUpdateEnabled' => true || false,
            ],
            '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>,
            ],
        ],
    ],
    'DryRunProgressStatus' => [
        'CreationDate' => '<string>',
        'DryRunId' => '<string>',
        'DryRunStatus' => '<string>',
        'UpdateDate' => '<string>',
        'ValidationFailures' => [
            [
                'Code' => '<string>',
                'Message' => '<string>',
            ],
            // ...
        ],
    ],
    'DryRunResults' => [
        'DeploymentType' => '<string>',
        'Message' => '<string>',
    ],
]

Result Details