AWS SDK for PHP 3.x

Client: Aws\OpenSearchService\OpenSearchServiceClient

Service ID: opensearch

Version: 2021-01-01

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

Operation Summary

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

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

AcceptInboundConnection ( array $params = [] ): Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request.
AddDataSource ( array $params = [] ): Creates a new direct-query data source to the specified domain.
AddTags ( array $params = [] ): Attaches tags to an existing Amazon OpenSearch Service domain.
AssociatePackage ( array $params = [] ): Associates a package with an Amazon OpenSearch Service domain.
AuthorizeVpcEndpointAccess ( array $params = [] ): Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
CancelDomainConfigChange ( array $params = [] ): Cancels a pending configuration change on an Amazon OpenSearch Service domain.
CancelServiceSoftwareUpdate ( array $params = [] ): Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
CreateDomain ( array $params = [] ): Creates an Amazon OpenSearch Service domain.
CreateOutboundConnection ( array $params = [] ): Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain.
CreatePackage ( array $params = [] ): Creates a package for use with Amazon OpenSearch Service domains.
CreateVpcEndpoint ( array $params = [] ): Creates an Amazon OpenSearch Service-managed VPC endpoint.
DeleteDataSource ( array $params = [] ): Deletes a direct-query data source.
DeleteDomain ( array $params = [] ): Deletes an Amazon OpenSearch Service domain and all of its data.
DeleteInboundConnection ( array $params = [] ): Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection.
DeleteOutboundConnection ( array $params = [] ): Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection.
DeletePackage ( array $params = [] ): Deletes an Amazon OpenSearch Service package.
DeleteVpcEndpoint ( array $params = [] ): Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
DescribeDomain ( array $params = [] ): Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
DescribeDomainAutoTunes ( array $params = [] ): Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.
DescribeDomainChangeProgress ( array $params = [] ): Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.
DescribeDomainConfig ( array $params = [] ): Returns the configuration of an Amazon OpenSearch Service domain.
DescribeDomainHealth ( array $params = [] ): Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.
DescribeDomainNodes ( array $params = [] ): Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.
DescribeDomains ( array $params = [] ): Returns domain configuration information about the specified Amazon OpenSearch Service domains.
DescribeDryRunProgress ( array $params = [] ): Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.
DescribeInboundConnections ( array $params = [] ): Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.
DescribeInstanceTypeLimits ( array $params = [] ): Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
DescribeOutboundConnections ( array $params = [] ): Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.
DescribePackages ( array $params = [] ): Describes all packages available to OpenSearch Service.
DescribeReservedInstanceOfferings ( array $params = [] ): Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
DescribeReservedInstances ( array $params = [] ): Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
DescribeVpcEndpoints ( array $params = [] ): Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
DissociatePackage ( array $params = [] ): Removes a package from the specified Amazon OpenSearch Service domain.
GetCompatibleVersions ( array $params = [] ): Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
GetDataSource ( array $params = [] ): Retrieves information about a direct query data source.
GetDomainMaintenanceStatus ( array $params = [] ): The status of the maintenance action.
GetPackageVersionHistory ( array $params = [] ): 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).
GetUpgradeHistory ( array $params = [] ): Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
GetUpgradeStatus ( array $params = [] ): Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
ListDataSources ( array $params = [] ): Lists direct-query data sources for a specific domain.
ListDomainMaintenances ( array $params = [] ): A list of maintenance actions for the domain.
ListDomainNames ( array $params = [] ): Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
ListDomainsForPackage ( array $params = [] ): Lists all Amazon OpenSearch Service domains associated with a given package.
ListInstanceTypeDetails ( array $params = [] ): Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
ListPackagesForDomain ( array $params = [] ): Lists all packages associated with an Amazon OpenSearch Service domain.
ListScheduledActions ( array $params = [] ): Retrieves a list of configuration changes that are scheduled for a domain.
ListTags ( array $params = [] ): Returns all resource tags for an Amazon OpenSearch Service domain.
ListVersions ( array $params = [] ): Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
ListVpcEndpointAccess ( array $params = [] ): 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.
ListVpcEndpoints ( array $params = [] ): Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
ListVpcEndpointsForDomain ( array $params = [] ): Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
PurchaseReservedInstanceOffering ( array $params = [] ): Allows you to purchase Amazon OpenSearch Service Reserved Instances.
RejectInboundConnection ( array $params = [] ): Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
RemoveTags ( array $params = [] ): Removes the specified set of tags from an Amazon OpenSearch Service domain.
RevokeVpcEndpointAccess ( array $params = [] ): Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
StartDomainMaintenance ( array $params = [] ): Starts the node maintenance process on the data node.
StartServiceSoftwareUpdate ( array $params = [] ): Schedules a service software update for an Amazon OpenSearch Service domain.
UpdateDataSource ( array $params = [] ): Updates a direct-query data source.
UpdateDomainConfig ( array $params = [] ): Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
UpdatePackage ( array $params = [] ): Updates a package for use with Amazon OpenSearch Service domains.
UpdateScheduledAction ( array $params = [] ): Reschedules a planned domain configuration change for a later time.
UpdateVpcEndpoint ( array $params = [] ): Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
UpgradeDomain ( array $params = [] ): Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

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

Operations

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

Members

ConnectionId

Required: Yes
Type: string

The ID of the inbound connection to accept.

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

Members

Connection

Type: InboundConnection structure

Information about the accepted inbound connection.

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

Members

DataSourceType

Required: Yes
Type: DataSourceType structure

The type of data source.

Description

Type: string

A description of the data source.

DomainName

Required: Yes
Type: string

The name of the domain to add the data source to.

Name

Required: Yes
Type: string

A name for the data source.

Result Syntax

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

Result Details

Members

Message

Type: string

A message associated with creation of the data source.

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

Members

ARN

Required: Yes
Type: string

Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.

TagList

Required: Yes
Type: Array of Tag structures

List of resource tags.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BaseException:
An error occurred while processing the request.
LimitExceededException:
An exception for trying to create more than 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([
    'DomainName' => '<string>', // REQUIRED
    'PackageID' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Required: Yes
Type: string

Name of the domain to associate the package with.

PackageID

Required: Yes
Type: string

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

Result Syntax

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

Result Details

Members

DomainPackageDetails

Type: DomainPackageDetails structure

Information about a package that is associated with a domain.

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.

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>', // REQUIRED
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

Account

Required: Yes
Type: string

The Amazon Web Services account ID to grant access to.

DomainName

Required: Yes
Type: string

The name of the OpenSearch Service domain to provide access to.

Result Syntax

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

Result Details

Members

AuthorizedPrincipal

Required: Yes
Type: AuthorizedPrincipal structure

Information about the Amazon Web Services account or service that was provided access to the domain.

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

Members

DomainName

Required: Yes
Type: string

The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

DryRun

Type: boolean

When set to True, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.

Result Syntax

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

Result Details

Members

CancelledChangeIds

Type: Array of strings

The unique identifiers of the changes that were cancelled.

CancelledChangeProperties

Type: Array of CancelledChangeProperty structures

The domain change properties that were cancelled.

DryRun

Type: boolean

Whether or not the request was a dry run. If True, the changes were not actually cancelled.

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

Members

DomainName

Required: Yes
Type: string

Name of the OpenSearch Service domain that you want to cancel the service software update on.

Result Syntax

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

Result Details

Members

ServiceSoftwareOptions

Type: ServiceSoftwareOptions structure

Container for the state of your domain relative to the latest service software.

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.

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([
    'AccessPolicies' => '<string>',
    'AdvancedOptions' => ['<string>', ...],
    'AdvancedSecurityOptions' => [
        'AnonymousAuthEnabled' => true || false,
        'Enabled' => true || false,
        'InternalUserDatabaseEnabled' => true || false,
        'MasterUserOptions' => [
            'MasterUserARN' => '<string>',
            'MasterUserName' => '<string>',
            'MasterUserPassword' => '<string>',
        ],
        'SAMLOptions' => [
            'Enabled' => true || false,
            'Idp' => [
                'EntityId' => '<string>', // REQUIRED
                'MetadataContent' => '<string>', // REQUIRED
            ],
            'MasterBackendRole' => '<string>',
            'MasterUserName' => '<string>',
            'RolesKey' => '<string>',
            'SessionTimeoutMinutes' => <integer>,
            'SubjectKey' => '<string>',
        ],
    ],
    'AutoTuneOptions' => [
        'DesiredState' => 'ENABLED|DISABLED',
        'MaintenanceSchedules' => [
            [
                'CronExpressionForRecurrence' => '<string>',
                'Duration' => [
                    'Unit' => 'HOURS',
                    'Value' => <integer>,
                ],
                'StartAt' => <integer || string || DateTime>,
            ],
            // ...
        ],
        '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,
        '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',
    '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

Members

AccessPolicies

Type: string

Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

AdvancedOptions

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

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

"rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
"override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

AdvancedSecurityOptions

Type: AdvancedSecurityOptionsInput structure

Options for fine-grained access control.

AutoTuneOptions

Type: AutoTuneOptionsInput structure

Options for Auto-Tune.

ClusterConfig

Type: ClusterConfig structure

Container for the cluster configuration of a domain.

CognitoOptions

Type: CognitoOptions structure

Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

DomainEndpointOptions

Type: DomainEndpointOptions structure

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

DomainName

Required: Yes
Type: string

Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

EBSOptions

Type: EBSOptions structure

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

EncryptionAtRestOptions

Type: EncryptionAtRestOptions structure

Key-value pairs to enable encryption at rest.

EngineVersion

Type: string

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

IPAddressType

Type: string

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.

LogPublishingOptions

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

Key-value pairs to configure log publishing.

NodeToNodeEncryptionOptions

Type: NodeToNodeEncryptionOptions structure

Enables node-to-node encryption.

OffPeakWindowOptions

Type: OffPeakWindowOptions structure

Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

SnapshotOptions

Type: SnapshotOptions structure

DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.

SoftwareUpdateOptions

Type: SoftwareUpdateOptions structure

Software update options for the domain.

TagList

Type: Array of Tag structures

List of tags to add to the domain upon creation.

VPCOptions

Type: VPCOptions structure

Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

Result Syntax

[
    'DomainStatus' => [
        'ARN' => '<string>',
        'AccessPolicies' => '<string>',
        'AdvancedOptions' => ['<string>', ...],
        'AdvancedSecurityOptions' => [
            'AnonymousAuthDisableDate' => <DateTime>,
            'AnonymousAuthEnabled' => true || false,
            'Enabled' => true || false,
            'InternalUserDatabaseEnabled' => true || false,
            'SAMLOptions' => [
                'Enabled' => true || false,
                'Idp' => [
                    'EntityId' => '<string>',
                    'MetadataContent' => '<string>',
                ],
                'RolesKey' => '<string>',
                'SessionTimeoutMinutes' => <integer>,
                'SubjectKey' => '<string>',
            ],
        ],
        'AutoTuneOptions' => [
            'ErrorMessage' => '<string>',
            'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
            '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,
            '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',
        '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

Members

DomainStatus

Type: DomainStatus structure

The status of the newly created domain.

Errors

BaseException:
An error occurred while processing the request.
DisabledOperationException:
An error occured because the client wanted to access 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

Members

ConnectionAlias

Required: Yes
Type: string

Name of the connection.

ConnectionMode

Type: string

The connection mode.

ConnectionProperties

Type: ConnectionProperties structure

The ConnectionProperties for the outbound connection.

LocalDomainInfo

Required: Yes
Type: DomainInformationContainer structure

Name and Region of the source (local) domain.

RemoteDomainInfo

Required: Yes
Type: DomainInformationContainer structure

Name and Region of the destination (remote) domain.

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

Members

ConnectionAlias

Type: string

Name of the connection.

ConnectionId

Type: string

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

ConnectionMode

Type: string

The connection mode.

ConnectionProperties

Type: ConnectionProperties structure

The ConnectionProperties for the newly created connection.

ConnectionStatus

Type: OutboundConnectionStatus structure

The status of the connection.

LocalDomainInfo

Type: DomainInformationContainer structure

Information about the source (local) domain.

RemoteDomainInfo

Type: DomainInformationContainer structure

Information about the destination (remote) domain.

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([
    'PackageDescription' => '<string>',
    'PackageName' => '<string>', // REQUIRED
    'PackageSource' => [ // REQUIRED
        'S3BucketName' => '<string>',
        'S3Key' => '<string>',
    ],
    'PackageType' => 'TXT-DICTIONARY|ZIP-PLUGIN', // REQUIRED
]);

Parameter Details

Members

PackageDescription

Type: string

Description of the package.

PackageName

Required: Yes
Type: string

Unique name for the package.

PackageSource

Required: Yes
Type: PackageSource structure

The Amazon S3 location from which to import the package.

PackageType

Required: Yes
Type: string

The type of package.

Result Syntax

[
    'PackageDetails' => [
        '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>',
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageStatus' => 'COPYING|COPY_FAILED|VALIDATING|VALIDATION_FAILED|AVAILABLE|DELETING|DELETED|DELETE_FAILED',
        'PackageType' => 'TXT-DICTIONARY|ZIP-PLUGIN',
    ],
]

Result Details

Members

PackageDetails

Type: PackageDetails structure

Basic information about an OpenSearch Service package.

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

Members

ClientToken

Type: string

Unique, case-sensitive identifier to ensure idempotency of the request.

DomainArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the domain to create the endpoint for.

VpcOptions

Required: Yes
Type: VPCOptions structure

Options to specify the subnets and security groups for the endpoint.

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

Members

VpcEndpoint

Required: Yes
Type: VpcEndpoint structure

Information about the newly created VPC endpoint.

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.

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

Members

DomainName

Required: Yes
Type: string

The name of the domain.

Name

Required: Yes
Type: string

The name of the data source to delete.

Result Syntax

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

Result Details

Members

Message

Type: string

A message associated with deletion of the data source.

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

Members

DomainName

Required: Yes
Type: string

The name of the domain you want to permanently delete.

Result Syntax

[
    'DomainStatus' => [
        'ARN' => '<string>',
        'AccessPolicies' => '<string>',
        'AdvancedOptions' => ['<string>', ...],
        'AdvancedSecurityOptions' => [
            'AnonymousAuthDisableDate' => <DateTime>,
            'AnonymousAuthEnabled' => true || false,
            'Enabled' => true || false,
            'InternalUserDatabaseEnabled' => true || false,
            'SAMLOptions' => [
                'Enabled' => true || false,
                'Idp' => [
                    'EntityId' => '<string>',
                    'MetadataContent' => '<string>',
                ],
                'RolesKey' => '<string>',
                'SessionTimeoutMinutes' => <integer>,
                'SubjectKey' => '<string>',
            ],
        ],
        'AutoTuneOptions' => [
            'ErrorMessage' => '<string>',
            'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
            '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,
            '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',
        '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

Members

DomainStatus

Type: DomainStatus structure

The status of the domain being deleted.

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

Members

ConnectionId

Required: Yes
Type: string

The ID of the inbound connection to permanently delete.

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

Members

Connection

Type: InboundConnection structure

The deleted inbound connection.

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

Members

ConnectionId

Required: Yes
Type: string

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

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

Members

Connection

Type: OutboundConnection structure

The deleted inbound connection.

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

Members

PackageID

Required: Yes
Type: string

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

Result Syntax

[
    'PackageDetails' => [
        'AvailablePackageVersion' => '<string>',
        'AvailablePluginProperties' => [
            'ClassName' => '<string>',
            'Description' => '<string>',
            'Name' => '<string>',
            'UncompressedSizeInBytes' => <integer>,
            'Version' => '<string>',
        ],
        'CreatedAt' => <DateTime>,
        'EngineVersion' => '<string>',
        'ErrorDetails' => [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        'LastUpdatedAt' => <DateTime>,
        'PackageDescription' => '<string>',
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageStatus' => 'COPYING|COPY_FAILED|VALIDATING|VALIDATION_FAILED|AVAILABLE|DELETING|DELETED|DELETE_FAILED',
        'PackageType' => 'TXT-DICTIONARY|ZIP-PLUGIN',
    ],
]

Result Details

Members

PackageDetails

Type: PackageDetails structure

Information about the deleted package.

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

Members

VpcEndpointId

Required: Yes
Type: string

The unique identifier of the endpoint.

Result Syntax

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

Result Details

Members

VpcEndpointSummary

Required: Yes
Type: VpcEndpointSummary structure

Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).

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

Members

DomainName

Required: Yes
Type: string

The name of the domain that you want information about.

Result Syntax

[
    'DomainStatus' => [
        'ARN' => '<string>',
        'AccessPolicies' => '<string>',
        'AdvancedOptions' => ['<string>', ...],
        'AdvancedSecurityOptions' => [
            'AnonymousAuthDisableDate' => <DateTime>,
            'AnonymousAuthEnabled' => true || false,
            'Enabled' => true || false,
            'InternalUserDatabaseEnabled' => true || false,
            'SAMLOptions' => [
                'Enabled' => true || false,
                'Idp' => [
                    'EntityId' => '<string>',
                    'MetadataContent' => '<string>',
                ],
                'RolesKey' => '<string>',
                'SessionTimeoutMinutes' => <integer>,
                'SubjectKey' => '<string>',
            ],
        ],
        'AutoTuneOptions' => [
            'ErrorMessage' => '<string>',
            'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
            '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,
            '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',
        '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

Members

DomainStatus

Required: Yes
Type: DomainStatus structure

List that contains the status of each specified OpenSearch Service domain.

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

Members

DomainName

Required: Yes
Type: string

Name of the domain that you want Auto-Tune details about.

MaxResults

Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

NextToken

Type: string

If your initial DescribeDomainAutoTunes operation returns a nextToken, you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.

Result Syntax

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

Result Details

Members

AutoTunes

Type: Array of AutoTune structures

The list of setting adjustments that Auto-Tune has made to the domain.

NextToken

Type: string

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

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

Members

ChangeId

Type: string

The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.

DomainName

Required: Yes
Type: string

The name of the domain to get progress information for.

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

Members

ChangeProgressStatus

Type: ChangeProgressStatusDetails structure

Container for information about the stages of a configuration change happening on a domain.

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

Members

DomainName

Required: Yes
Type: string

Name of the OpenSearch Service domain configuration that you want to describe.

Result Syntax

[
    'DomainConfig' => [
        'AccessPolicies' => [
            'Options' => '<string>',
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AdvancedOptions' => [
            'Options' => ['<string>', ...],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AdvancedSecurityOptions' => [
            'Options' => [
                'AnonymousAuthDisableDate' => <DateTime>,
                'AnonymousAuthEnabled' => true || false,
                'Enabled' => true || false,
                'InternalUserDatabaseEnabled' => true || false,
                'SAMLOptions' => [
                    'Enabled' => true || false,
                    'Idp' => [
                        'EntityId' => '<string>',
                        'MetadataContent' => '<string>',
                    ],
                    'RolesKey' => '<string>',
                    'SessionTimeoutMinutes' => <integer>,
                    'SubjectKey' => '<string>',
                ],
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AutoTuneOptions' => [
            'Options' => [
                'DesiredState' => 'ENABLED|DISABLED',
                'MaintenanceSchedules' => [
                    [
                        'CronExpressionForRecurrence' => '<string>',
                        'Duration' => [
                            'Unit' => 'HOURS',
                            'Value' => <integer>,
                        ],
                        'StartAt' => <DateTime>,
                    ],
                    // ...
                ],
                'RollbackOnDisable' => 'NO_ROLLBACK|DEFAULT_ROLLBACK',
                '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,
                '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>,
            ],
        ],
        '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

Members

DomainConfig

Required: Yes
Type: DomainConfig structure

Container for the configuration of the OpenSearch Service domain.

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

Members

DomainName

Required: Yes
Type: string

The name of the domain.

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

Members

ActiveAvailabilityZoneCount

Type: string

The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

AvailabilityZoneCount

Type: string

The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

ClusterHealth

Type: string

The current health status of your cluster.

Red - At least one primary shard is not allocated to any node.
Yellow - All primary shards are allocated to nodes, but some replicas aren’t.
Green - All primary shards and their replicas are allocated to nodes.
NotAvailable - Unable to retrieve cluster health.

DataNodeCount

Type: string

The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

DedicatedMaster

Type: boolean

A boolean that indicates if dedicated master nodes are activated for the domain.

DomainState

Type: string

The current state of the domain.

Processing - The domain has updates in progress.
Active - Requested changes have been processed and deployed to the domain.

EnvironmentInformation

Type: Array of EnvironmentInfo structures

A list of EnvironmentInfo for the domain.

MasterEligibleNodeCount

Type: string

The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

MasterNode

Type: string

Indicates whether the domain has an elected master node.

Available - The domain has an elected master node.
UnAvailable - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached.

StandByAvailabilityZoneCount

Type: string

The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

TotalShards

Type: string

The total number of primary and replica shards for the domain.

TotalUnAssignedShards

Type: string

The total number of primary and replica shards not allocated to any of the nodes for the cluster.

WarmNodeCount

Type: string

The number of warm nodes configured for the domain.

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

Members

DomainName

Required: Yes
Type: string

The name of the domain.

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

Members

DomainNodesStatusList

Type: Array of DomainNodesStatus structures

Contains nodes information list DomainNodesStatusList with details about the all nodes on the requested domain.

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

Members

DomainNames

Required: Yes
Type: Array of strings

Array of OpenSearch Service domain names that you want information about. You must specify at least one domain name.

Result Syntax

[
    'DomainStatusList' => [
        [
            'ARN' => '<string>',
            'AccessPolicies' => '<string>',
            'AdvancedOptions' => ['<string>', ...],
            'AdvancedSecurityOptions' => [
                'AnonymousAuthDisableDate' => <DateTime>,
                'AnonymousAuthEnabled' => true || false,
                'Enabled' => true || false,
                'InternalUserDatabaseEnabled' => true || false,
                'SAMLOptions' => [
                    'Enabled' => true || false,
                    'Idp' => [
                        'EntityId' => '<string>',
                        'MetadataContent' => '<string>',
                    ],
                    'RolesKey' => '<string>',
                    'SessionTimeoutMinutes' => <integer>,
                    'SubjectKey' => '<string>',
                ],
            ],
            'AutoTuneOptions' => [
                'ErrorMessage' => '<string>',
                'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
                '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,
                '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',
            '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

Members

DomainStatusList

Required: Yes
Type: Array of DomainStatus structures

The status of the requested domains.

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

Members

DomainName

Required: Yes
Type: string

The name of the domain.

DryRunId

Type: string

The unique identifier of the dry run.

LoadDryRunConfig

Type: boolean

Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you're planning to make on the domain.

Result Syntax

[
    'DryRunConfig' => [
        'ARN' => '<string>',
        'AccessPolicies' => '<string>',
        'AdvancedOptions' => ['<string>', ...],
        'AdvancedSecurityOptions' => [
            'AnonymousAuthDisableDate' => <DateTime>,
            'AnonymousAuthEnabled' => true || false,
            'Enabled' => true || false,
            'InternalUserDatabaseEnabled' => true || false,
            'SAMLOptions' => [
                'Enabled' => true || false,
                'Idp' => [
                    'EntityId' => '<string>',
                    'MetadataContent' => '<string>',
                ],
                'RolesKey' => '<string>',
                'SessionTimeoutMinutes' => <integer>,
                'SubjectKey' => '<string>',
            ],
        ],
        'AutoTuneOptions' => [
            'ErrorMessage' => '<string>',
            'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
            '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,
            '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',
        '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

Members

DryRunConfig

Type: DomainStatus structure

Details about the changes you're planning to make on the domain.

DryRunProgressStatus

Type: DryRunProgressStatus structure

The current status of the dry run, including any validation errors.

DryRunResults

Type: DryRunResults structure

The results of the dry run.

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

Members

Filters

Type: Array of Filter structures

A list of filters used to match properties for inbound cross-cluster connections.

MaxResults

Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

NextToken

Type: string

If your initial DescribeInboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeInboundConnections operations, which returns results in the next page.

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

Members

Connections

Type: Array of InboundConnection structures

List of inbound connections.

NextToken

Type: string

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

Members

DomainName

Type: string

The name of the domain. Only specify if you need the limits for an existing domain.

EngineVersion

Required: Yes
Type: string

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

InstanceType

Required: Yes
Type: string

The OpenSearch Service instance type for which you need limit information.

Result Syntax

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

Result Details

Members

LimitsByRole

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

Map that contains all applicable instance type limits.data refers to data nodes.master refers to dedicated master nodes.

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

Members

Filters

Type: Array of Filter structures

List of filter names and values that you can use for requests.

MaxResults

Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

NextToken

Type: string

If your initial DescribeOutboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.

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

Members

Connections

Type: Array of OutboundConnection structures

List of outbound connections that match the filter criteria.

NextToken

Type: string

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',
            'Value' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of DescribePackagesFilter structures

Only returns packages that match the DescribePackagesFilterList values.

MaxResults

Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

NextToken

Type: string

If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.

Result Syntax

[
    'NextToken' => '<string>',
    'PackageDetailsList' => [
        [
            '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>',
            'PackageID' => '<string>',
            'PackageName' => '<string>',
            'PackageStatus' => 'COPYING|COPY_FAILED|VALIDATING|VALIDATION_FAILED|AVAILABLE|DELETING|DELETED|DELETE_FAILED',
            'PackageType' => 'TXT-DICTIONARY|ZIP-PLUGIN',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

PackageDetailsList

Type: Array of PackageDetails structures

Basic information about a package.

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

Members

MaxResults

Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

NextToken

Type: string

If your initial DescribeReservedInstanceOfferings operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.

ReservedInstanceOfferingId

Type: string

The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.

Result Syntax

[
    'NextToken' => '<string>',
    'ReservedInstanceOfferings' => [
        [
            'CurrencyCode' => '<string>',
            'Duration' => <integer>,
            'FixedPrice' => <float>,
            'InstanceType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|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

Members

NextToken

Type: string

ReservedInstanceOfferings

Type: Array of ReservedInstanceOffering structures

List of Reserved Instance offerings.

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

Members

MaxResults

Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

NextToken

Type: string

If your initial DescribeReservedInstances operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.

ReservedInstanceId

Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'ReservedInstances' => [
        [
            'BillingSubscriptionId' => <integer>,
            'CurrencyCode' => '<string>',
            'Duration' => <integer>,
            'FixedPrice' => <float>,
            'InstanceCount' => <integer>,
            'InstanceType' => 'm3.medium.search|m3.large.search|m3.xlarge.search|m3.2xlarge.search|m4.large.search|m4.xlarge.search|m4.2xlarge.search|m4.4xlarge.search|m4.10xlarge.search|m5.large.search|m5.xlarge.search|m5.2xlarge.search|m5.4xlarge.search|m5.12xlarge.search|m5.24xlarge.search|r5.large.search|r5.xlarge.search|r5.2xlarge.search|r5.4xlarge.search|r5.12xlarge.search|r5.24xlarge.search|c5.large.search|c5.xlarge.search|c5.2xlarge.search|c5.4xlarge.search|c5.9xlarge.search|c5.18xlarge.search|t3.nano.search|t3.micro.search|t3.small.search|t3.medium.search|t3.large.search|t3.xlarge.search|t3.2xlarge.search|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

Members

NextToken

Type: string

ReservedInstances

Type: Array of ReservedInstance structures

List of Reserved Instances in the current Region.

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

Members

VpcEndpointIds

Required: Yes
Type: Array of strings

The unique identifiers of the endpoints to get information about.

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

Members

VpcEndpointErrors

Required: Yes
Type: Array of VpcEndpointError structures

Any errors associated with the request.

VpcEndpoints

Required: Yes
Type: Array of VpcEndpoint structures

Information about each requested VPC endpoint.

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

Members

DomainName

Required: Yes
Type: string

Name of the domain to dissociate the package from.

PackageID

Required: Yes
Type: string

Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.

Result Syntax

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

Result Details

Members

DomainPackageDetails

Type: DomainPackageDetails structure

Information about a package that has been dissociated from the domain.

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.

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

Members

DomainName

Type: string

The name of an existing domain. Provide this parameter to limit the results to a single domain.

Result Syntax

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

Result Details

Members

CompatibleVersions

Type: Array of CompatibleVersionsMap structures

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

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

Members

DomainName

Required: Yes
Type: string

The name of the domain.

Name

Required: Yes
Type: string

The name of the data source to get information about.

Result Syntax

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

Result Details

Members

DataSourceType

Type: DataSourceType structure

The type of data source.

Description

Type: string

A description of the data source.

Name

Type: string

The name of the data source.

Status

Type: string

The status of the data source response.

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

Members

DomainName

Required: Yes
Type: string

The name of the domain.

MaintenanceId

Required: Yes
Type: string

The request ID of the maintenance action.

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

Members

Action

Type: string

The action name.

CreatedAt

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

The time at which the action was created.

NodeId

Type: string

The node ID of the maintenance action.

Status

Type: string

The status of the maintenance action.

StatusMessage

Type: string

The status message of the maintenance action.

UpdatedAt

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

The time at which the action was updated.

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

Members

MaxResults

Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

NextToken

Type: string

If your initial GetPackageVersionHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.

PackageID

Required: Yes
Type: string

The unique identifier of the package.

Result Syntax

[
    'NextToken' => '<string>',
    'PackageID' => '<string>',
    'PackageVersionHistoryList' => [
        [
            'CommitMessage' => '<string>',
            'CreatedAt' => <DateTime>,
            'PackageVersion' => '<string>',
            'PluginProperties' => [
                'ClassName' => '<string>',
                'Description' => '<string>',
                'Name' => '<string>',
                'UncompressedSizeInBytes' => <integer>,
                'Version' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

PackageID

Type: string

The unique identifier of the package.

PackageVersionHistoryList

Type: Array of PackageVersionHistory structures

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

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

Members

DomainName

Required: Yes
Type: string

The name of an existing domain.

MaxResults

Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

NextToken

Type: string

If your initial GetUpgradeHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetUpgradeHistory operations, which returns results in the next page.

Result Syntax

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

Result Details

Members

NextToken

Type: string

UpgradeHistories

Type: Array of UpgradeHistory structures

A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.

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

Members

DomainName

Required: Yes
Type: string

The domain of the domain to get upgrade status information for.

Result Syntax

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

Result Details

Members

StepStatus

Type: string

The status of the current step that an upgrade is on.

UpgradeName

Type: string

A string that describes the update.

UpgradeStep

Type: string

One of three steps that an upgrade or upgrade eligibility check goes through.

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.

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

Members

DomainName

Required: Yes
Type: string

The name of the domain.

Result Syntax

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

Result Details

Members

DataSources

Type: Array of DataSourceDetails structures

A list of data sources associated with specified domain.

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

Members

Action

Type: string

The name of the action.

DomainName

Required: Yes
Type: string

The name of the domain.

MaxResults

Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

NextToken

Type: string

If your initial ListDomainMaintenances operation returns a nextToken, include the returned nextToken in subsequent ListDomainMaintenances operations, which returns results in the next page.

Status

Type: string

The status of the action.

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

Members

DomainMaintenances

Type: Array of DomainMaintenanceDetails structures

A list of the submitted maintenance actions.

NextToken

Type: string

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

Members

EngineType

Type: string

Filters the output by domain engine type.

Result Syntax

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

Result Details

Members

DomainNames

Type: Array of DomainInfo structures

The names of all OpenSearch Service domains owned by the current user and their respective engine types.

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

Members

MaxResults

Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

NextToken

Type: string

If your initial ListDomainsForPackage operation returns a nextToken, you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.

PackageID

Required: Yes
Type: string

The unique identifier of the package for which to list associated domains.

Result Syntax

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

Result Details

Members

DomainPackageDetailsList

Type: Array of DomainPackageDetails structures

Information about all domains associated with a package.

NextToken

Type: string

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

Members

DomainName

Type: string

The name of the domain.

EngineVersion

Required: Yes
Type: string

The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

InstanceType

Type: string

An optional parameter that lists information for a given instance type.

MaxResults

Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

NextToken

Type: string

If your initial ListInstanceTypeDetails operation returns a nextToken, you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.

RetrieveAZs

Type: boolean

An optional parameter that specifies the Availability Zones for the domain.

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

Members

InstanceTypeDetails

Type: Array of InstanceTypeDetails structures

Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.

NextToken

Type: string

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

Members

DomainName

Required: Yes
Type: string

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

MaxResults

Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

NextToken

Type: string

If your initial ListPackagesForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page.

Result Syntax

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

Result Details

Members

DomainPackageDetailsList

Type: Array of DomainPackageDetails structures

List of all packages associated with a domain.

NextToken

Type: string

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

Members

DomainName

Required: Yes
Type: string

The name of the domain.

MaxResults

Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

NextToken

Type: string

If your initial ListScheduledActions operation returns a nextToken, you can include the returned nextToken in subsequent ListScheduledActions operations, which returns results in the next page.

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

Members

NextToken

Type: string

ScheduledActions

Type: Array of ScheduledAction structures

A list of actions that are scheduled for the domain.

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.

$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

Members

ARN

Required: Yes
Type: string

Amazon Resource Name (ARN) for the domain to view tags for.

Result Syntax

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

Result Details

Members

TagList

Type: Array of Tag structures

List of resource tags associated with the specified domain.

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

Members

MaxResults

Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

NextToken

Type: string

If your initial ListVersions operation returns a nextToken, you can include the returned nextToken in subsequent ListVersions operations, which returns results in the next page.

Result Syntax

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

Result Details

Members

NextToken

Type: string

Versions

Type: Array of strings

A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

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

Members

DomainName

Required: Yes
Type: string

The name of the OpenSearch Service domain to retrieve access information for.

NextToken

Type: string

If your initial ListVpcEndpointAccess operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpointAccess operations, which returns results in the next page.

Result Syntax

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

Result Details

Members

AuthorizedPrincipalList

Required: Yes
Type: Array of AuthorizedPrincipal structures

A list of IAM principals that can currently access the domain.

NextToken

Required: Yes
Type: string

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

Members

NextToken

Type: string

If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.

Result Syntax

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

Result Details

Members

NextToken

Required: Yes
Type: string

VpcEndpointSummaryList

Required: Yes
Type: Array of VpcEndpointSummary structures

Information about each endpoint.

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

Members

DomainName

Required: Yes
Type: string

The name of the domain to list associated VPC endpoints for.

NextToken

Type: string

If your initial ListEndpointsForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListEndpointsForDomain operations, which returns results in the next page.

Result Syntax

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

Result Details

Members

NextToken

Required: Yes
Type: string

VpcEndpointSummaryList

Required: Yes
Type: Array of VpcEndpointSummary structures

Information about each endpoint associated with the domain.

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

Members

InstanceCount

Type: int

The number of OpenSearch instances to reserve.

ReservationName

Required: Yes
Type: string

A customer-specified identifier to track this reservation.

ReservedInstanceOfferingId

Required: Yes
Type: string

The ID of the Reserved Instance offering to purchase.

Result Syntax

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

Result Details

Members

ReservationName

Type: string

The customer-specified identifier used to track this reservation.

ReservedInstanceId

Type: string

The ID of the Reserved Instance offering that was purchased.

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

Members

ConnectionId

Required: Yes
Type: string

The unique identifier of the inbound connection to reject.

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

Members

Connection

Type: InboundConnection structure

Contains details about the rejected inbound connection.

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

Members

ARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.

TagKeys

Required: Yes
Type: Array of strings

The list of tag keys to remove from the domain.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BaseException:
An error occurred while processing the request.
ValidationException:
An exception for 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>', // REQUIRED
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

Account

Required: Yes
Type: string

The account ID to revoke access from.

DomainName

Required: Yes
Type: string

The name of the OpenSearch Service domain.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

Action

Required: Yes
Type: string

The name of the action.

DomainName

Required: Yes
Type: string

The name of the domain.

NodeId

Type: string

The ID of the data node.

Result Syntax

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

Result Details

Members

MaintenanceId

Type: string

The request ID of requested action.

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

Members

DesiredStartTime

Type: long (int|float)

The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

DomainName

Required: Yes
Type: string

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

ScheduleAt

Type: string

When to start the service software update.

NOW - Immediately schedules the update to happen in the current hour if there's capacity available.
TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.
OFF_PEAK_WINDOW - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

Result Syntax

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

Result Details

Members

ServiceSoftwareOptions

Type: ServiceSoftwareOptions structure

The current status of the OpenSearch Service software update.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
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.

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

Members

DataSourceType

Required: Yes
Type: DataSourceType structure

The type of data source.

Description

Type: string

A new description of the data source.

DomainName

Required: Yes
Type: string

The name of the domain.

Name

Required: Yes
Type: string

The name of the data source to modify.

Status

Type: string

The status of the data source update request.

Result Syntax

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

Result Details

Members

Message

Type: string

A message associated with the updated data source.

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([
    'AccessPolicies' => '<string>',
    'AdvancedOptions' => ['<string>', ...],
    'AdvancedSecurityOptions' => [
        'AnonymousAuthEnabled' => true || false,
        'Enabled' => true || false,
        'InternalUserDatabaseEnabled' => true || false,
        'MasterUserOptions' => [
            'MasterUserARN' => '<string>',
            'MasterUserName' => '<string>',
            'MasterUserPassword' => '<string>',
        ],
        'SAMLOptions' => [
            'Enabled' => true || false,
            'Idp' => [
                'EntityId' => '<string>', // REQUIRED
                'MetadataContent' => '<string>', // REQUIRED
            ],
            'MasterBackendRole' => '<string>',
            'MasterUserName' => '<string>',
            'RolesKey' => '<string>',
            'SessionTimeoutMinutes' => <integer>,
            'SubjectKey' => '<string>',
        ],
    ],
    'AutoTuneOptions' => [
        'DesiredState' => 'ENABLED|DISABLED',
        'MaintenanceSchedules' => [
            [
                'CronExpressionForRecurrence' => '<string>',
                'Duration' => [
                    'Unit' => 'HOURS',
                    'Value' => <integer>,
                ],
                'StartAt' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'RollbackOnDisable' => 'NO_ROLLBACK|DEFAULT_ROLLBACK',
        '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,
        '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',
    '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

Members

AccessPolicies

Type: string

Identity and Access Management (IAM) access policy as a JSON-formatted string.

AdvancedOptions

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

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

"rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.

For more information, see Advanced cluster parameters.

AdvancedSecurityOptions

Type: AdvancedSecurityOptionsInput structure

Options for fine-grained access control.

AutoTuneOptions

Type: AutoTuneOptions structure

Options for Auto-Tune.

ClusterConfig

Type: ClusterConfig structure

Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

CognitoOptions

Type: CognitoOptions structure

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

DomainEndpointOptions

Type: DomainEndpointOptions structure

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

DomainName

Required: Yes
Type: string

The name of the domain that you're updating.

DryRun

Type: boolean

This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.

DryRunMode

Type: string

The type of dry run to perform.

Basic only returns the type of deployment (blue/green or dynamic) that the update will cause.
Verbose runs an additional check to validate the changes you're making. For more information, see Validating a domain update.

EBSOptions

Type: EBSOptions structure

The type and size of the EBS volume to attach to instances in the domain.

EncryptionAtRestOptions

Type: EncryptionAtRestOptions structure

Encryption at rest options for the domain.

IPAddressType

Type: string

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is currently set to dual stack, you can't change it.

LogPublishingOptions

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

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

NodeToNodeEncryptionOptions

Type: NodeToNodeEncryptionOptions structure

Node-to-node encryption options for the domain.

OffPeakWindowOptions

Type: OffPeakWindowOptions structure

Off-peak window options for the domain.

SnapshotOptions

Type: SnapshotOptions structure

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

SoftwareUpdateOptions

Type: SoftwareUpdateOptions structure

Service software update options for the domain.

VPCOptions

Type: VPCOptions structure

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

Result Syntax

[
    'DomainConfig' => [
        'AccessPolicies' => [
            'Options' => '<string>',
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AdvancedOptions' => [
            'Options' => ['<string>', ...],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AdvancedSecurityOptions' => [
            'Options' => [
                'AnonymousAuthDisableDate' => <DateTime>,
                'AnonymousAuthEnabled' => true || false,
                'Enabled' => true || false,
                'InternalUserDatabaseEnabled' => true || false,
                'SAMLOptions' => [
                    'Enabled' => true || false,
                    'Idp' => [
                        'EntityId' => '<string>',
                        'MetadataContent' => '<string>',
                    ],
                    'RolesKey' => '<string>',
                    'SessionTimeoutMinutes' => <integer>,
                    'SubjectKey' => '<string>',
                ],
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AutoTuneOptions' => [
            'Options' => [
                'DesiredState' => 'ENABLED|DISABLED',
                'MaintenanceSchedules' => [
                    [
                        'CronExpressionForRecurrence' => '<string>',
                        'Duration' => [
                            'Unit' => 'HOURS',
                            'Value' => <integer>,
                        ],
                        'StartAt' => <DateTime>,
                    ],
                    // ...
                ],
                'RollbackOnDisable' => 'NO_ROLLBACK|DEFAULT_ROLLBACK',
                '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,
                '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>,
            ],
        ],
        '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

Members

DomainConfig

Required: Yes
Type: DomainConfig structure

The status of the updated domain.

DryRunProgressStatus

Type: DryRunProgressStatus structure

The status of the dry run being performed on the domain, if any.

DryRunResults

Type: DryRunResults structure

Results of the dry run performed in the update domain request.

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.

UpdatePackage

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

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

Parameter Syntax

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

Parameter Details

Members

CommitMessage

Type: string

Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.

PackageDescription

Type: string

A new description of the package.

PackageID

Required: Yes
Type: string

The unique identifier for the package.

PackageSource

Required: Yes
Type: PackageSource structure

Amazon S3 bucket and key for the package.

Result Syntax

[
    'PackageDetails' => [
        '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>',
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageStatus' => 'COPYING|COPY_FAILED|VALIDATING|VALIDATION_FAILED|AVAILABLE|DELETING|DELETED|DELETE_FAILED',
        'PackageType' => 'TXT-DICTIONARY|ZIP-PLUGIN',
    ],
]

Result Details

Members

PackageDetails

Type: PackageDetails structure

Information about a package.

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.
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.

UpdateScheduledAction

$result = $client->updateScheduledAction([/* ... */]);
$promise = $client->updateScheduledActionAsync([/* ... */]);

Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.

Parameter Syntax

$result = $client->updateScheduledAction([
    'ActionID' => '<string>', // REQUIRED
    'ActionType' => 'SERVICE_SOFTWARE_UPDATE|JVM_HEAP_SIZE_TUNING|JVM_YOUNG_GEN_TUNING', // REQUIRED
    'DesiredStartTime' => <integer>,
    'DomainName' => '<string>', // REQUIRED
    'ScheduleAt' => 'NOW|TIMESTAMP|OFF_PEAK_WINDOW', // REQUIRED
]);

Parameter Details

Members

ActionID

Required: Yes
Type: string

The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

ActionType

Required: Yes
Type: string

The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

DesiredStartTime

Type: long (int|float)

The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

DomainName

Required: Yes
Type: string

The name of the domain to reschedule an action for.

ScheduleAt

Required: Yes
Type: string

When to schedule the action.

NOW - Immediately schedules the update to happen in the current hour if there's capacity available.
TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.
OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

Result Syntax

[
    'ScheduledAction' => [
        '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

Members

ScheduledAction

Type: ScheduledAction structure

Information about the rescheduled action.

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.
SlotNotAvailableException:
An exception for attempting to schedule a domain action during an unavailable time slot.
ConflictException:
An error occurred because the client attempts to remove a resource that is currently in use.
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.

UpdateVpcEndpoint

$result = $client->updateVpcEndpoint([/* ... */]);
$promise = $client->updateVpcEndpointAsync([/* ... */]);

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Parameter Syntax

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

Parameter Details

Members

VpcEndpointId

Required: Yes
Type: string

The unique identifier of the endpoint.

VpcOptions

Required: Yes
Type: VPCOptions structure

The security groups and/or subnets to add, remove, or modify.

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

Members

VpcEndpoint

Required: Yes
Type: VpcEndpoint structure

The endpoint to be updated.

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.
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.
BaseException:
An error occurred while processing the request.

UpgradeDomain

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

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

Parameter Syntax

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

Parameter Details

Members

AdvancedOptions

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

Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.

DomainName

Required: Yes
Type: string

Name of the OpenSearch Service domain that you want to upgrade.

PerformCheckOnly

Type: boolean

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

TargetVersion

Required: Yes
Type: string

OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

Result Syntax

[
    'AdvancedOptions' => ['<string>', ...],
    'ChangeProgressDetails' => [
        'ChangeId' => '<string>',
        'ConfigChangeStatus' => 'Pending|Initializing|Validating|ValidationFailed|ApplyingChanges|Completed|PendingUserInput|Cancelled',
        'InitiatedBy' => 'CUSTOMER|SERVICE',
        'LastUpdatedTime' => <DateTime>,
        'Message' => '<string>',
        'StartTime' => <DateTime>,
    ],
    'DomainName' => '<string>',
    'PerformCheckOnly' => true || false,
    'TargetVersion' => '<string>',
    'UpgradeId' => '<string>',
]

Result Details

Members

AdvancedOptions

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

The advanced options configuration for the domain.

ChangeProgressDetails

Type: ChangeProgressDetails structure

Container for information about a configuration change happening on a domain.

DomainName

Type: string

The name of the domain that was upgraded.

PerformCheckOnly

Type: boolean

When true, indicates that an upgrade eligibility check was performed.

TargetVersion

Type: string

OpenSearch or Elasticsearch version that the domain was upgraded to.

UpgradeId

Type: string

The unique identifier of the domain upgrade.

Errors

BaseException:
An error occurred while processing the request.
ResourceNotFoundException:
An exception for accessing or deleting a resource that doesn't exist.
ResourceAlreadyExistsException:
An exception for creating a resource that already exists.
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.

Shapes

AWSDomainInformation

Description

Information about an Amazon OpenSearch Service domain.

Members

DomainName

Required: Yes
Type: string

Name of the domain.

OwnerId

Type: string

The Amazon Web Services account ID of the domain owner.

Region

Type: string

The Amazon Web Services Region in which the domain is located.

AccessDeniedException

Description

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

Members

AccessPoliciesStatus

Description

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

Members

Options

Required: Yes
Type: string

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

Status

Required: Yes
Type: OptionStatus structure

The status of the access policy for the domain.

AdditionalLimit

Description

List of limits that are specific to a given instance type.

Members

LimitName

Type: string

MaximumNumberOfDataNodesSupported - This attribute only applies to master nodes and specifies the maximum number of data nodes of a given instance type a master node can support.
MaximumNumberOfDataNodesWithoutMasterNode - This attribute only applies to data nodes and specifies the maximum number of data nodes of a given instance type can exist without a master node governing them.

LimitValues

Type: Array of strings

The values of the additional instance type limits.

AdvancedOptionsStatus

Description

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

"rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
"override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

Members

Options

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

The status of advanced options for the specified domain.

Status

Required: Yes
Type: OptionStatus structure

The status of advanced options for the specified domain.

AdvancedSecurityOptions

Description

Container for fine-grained access control settings.

Members

AnonymousAuthDisableDate

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

Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

AnonymousAuthEnabled

Type: boolean

True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

Enabled

Type: boolean

True if fine-grained access control is enabled.

InternalUserDatabaseEnabled

Type: boolean

True if the internal user database is enabled.

SAMLOptions

Type: SAMLOptionsOutput structure

Container for information about the SAML configuration for OpenSearch Dashboards.

AdvancedSecurityOptionsInput

Description

Options for enabling and configuring fine-grained access control. For more information, see Fine-grained access control in Amazon OpenSearch Service.

Members

AnonymousAuthEnabled

Type: boolean

True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

Enabled

Type: boolean

True to enable fine-grained access control.

InternalUserDatabaseEnabled

Type: boolean

True to enable the internal user database.

MasterUserOptions

Type: MasterUserOptions structure

Container for information about the master user.

SAMLOptions

Type: SAMLOptionsInput structure

Container for information about the SAML configuration for OpenSearch Dashboards.

AdvancedSecurityOptionsStatus

Description

The status of fine-grained access control settings for a domain.

Members

Options

Required: Yes
Type: AdvancedSecurityOptions structure

Container for fine-grained access control settings.

Status

Required: Yes
Type: OptionStatus structure

Status of the fine-grained access control settings for a domain.

AuthorizedPrincipal

Description

Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Members

Principal

Type: string

The IAM principal that is allowed access to the domain.

PrincipalType

Type: string

The type of principal.

AutoTune

Description

Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

Members

AutoTuneDetails

Type: AutoTuneDetails structure

Details about an Auto-Tune action.

AutoTuneType

Type: string

The type of Auto-Tune action.

AutoTuneDetails

Description

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

Members

ScheduledAutoTuneDetails

Type: ScheduledAutoTuneDetails structure

Container for details about a scheduled Auto-Tune action.

AutoTuneMaintenanceSchedule

Description

This object is deprecated. Use the domain's off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows.

The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

Members

CronExpressionForRecurrence

Type: string

A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

Duration

Type: Duration structure

The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"}.

StartAt

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

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

AutoTuneOptions

Description

Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

Members

DesiredState

Type: string

Whether Auto-Tune is enabled or disabled.

MaintenanceSchedules

Type: Array of AutoTuneMaintenanceSchedule structures

DEPRECATED. Use off-peak window instead.

A list of maintenance schedules during which Auto-Tune can deploy changes.

RollbackOnDisable

Type: string

When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

UseOffPeakWindow

Type: boolean

Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.

AutoTuneOptionsInput

Description

Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service

Members

DesiredState

Type: string

Whether Auto-Tune is enabled or disabled.

MaintenanceSchedules

Type: Array of AutoTuneMaintenanceSchedule structures

A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with off-peak windows.

UseOffPeakWindow

Type: boolean

Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.

AutoTuneOptionsOutput

Description

The Auto-Tune settings for a domain, displayed when enabling or disabling Auto-Tune.

Members

ErrorMessage

Type: string

Any errors that occurred while enabling or disabling Auto-Tune.

State

Type: string

The current state of Auto-Tune on the domain.

UseOffPeakWindow

Type: boolean

Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.

AutoTuneOptionsStatus

Description

The Auto-Tune status for the domain.

Members

Options

Type: AutoTuneOptions structure

Auto-Tune settings for updating a domain.

Status

Type: AutoTuneStatus structure

The current status of Auto-Tune for a domain.

AutoTuneStatus

Description

The current status of Auto-Tune for the domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

Members

CreationDate

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

Date and time when Auto-Tune was enabled for the domain.

ErrorMessage

Type: string

Any errors that occurred while enabling or disabling Auto-Tune.

PendingDeletion

Type: boolean

Indicates whether the domain is being deleted.

State

Required: Yes
Type: string

The current state of Auto-Tune on the domain.

UpdateDate

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

Date and time when the Auto-Tune options were last updated for the domain.

UpdateVersion

Type: int

The latest version of the Auto-Tune options.

AvailabilityZoneInfo

Description

Information about an Availability Zone on a domain.

Members

AvailabilityZoneName

Type: string

The name of the Availability Zone.

AvailableDataNodeCount

Type: string

The number of data nodes active in the Availability Zone.

ConfiguredDataNodeCount

Type: string

The total number of data nodes configured in the Availability Zone.

TotalShards

Type: string

The total number of primary and replica shards in the Availability Zone.

TotalUnAssignedShards

Type: string

The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.

ZoneStatus

Type: string

The current state of the Availability Zone. Current options are Active and StandBy.

Active - Data nodes in the Availability Zone are in use.
StandBy - Data nodes in the Availability Zone are in a standby state.
NotAvailable - Unable to retrieve information.

BaseException

Description

An error occurred while processing the request.

Members

message

Type: string

A description of the error.

CancelledChangeProperty

Description

A property change that was cancelled for an Amazon OpenSearch Service domain.

Members

ActiveValue

Type: string

The current value of the property, after the change was cancelled.

CancelledValue

Type: string

The pending value of the property that was cancelled. This would have been the eventual value of the property if the chance had not been cancelled.

PropertyName

Type: string

The name of the property whose change was cancelled.

ChangeProgressDetails

Description

Container for information about a configuration change happening on a domain.

Members

ChangeId

Type: string

The ID of the configuration change.

ConfigChangeStatus

Type: string

The current status of the configuration change.

InitiatedBy

Type: string

The IAM principal who initiated the configuration change.

LastUpdatedTime

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

The last time that the configuration change was updated.

Message

Type: string

A message corresponding to the status of the configuration change.

StartTime

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

The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

ChangeProgressStage

Description

Progress details for each stage of a domain update.

Members

Description

Type: string

The description of the stage.

LastUpdated

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

The most recent updated timestamp of the stage.

Name

Type: string

The name of the stage.

Status

Type: string

The status of the stage.

ChangeProgressStatusDetails

Description

The progress details of a specific domain configuration change.

Members

ChangeId

Type: string

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

ChangeProgressStages

Type: Array of ChangeProgressStage structures

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

CompletedProperties

Type: Array of strings

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

ConfigChangeStatus

Type: string

The current status of the configuration change.

InitiatedBy

Type: string

The IAM principal who initiated the configuration change.

LastUpdatedTime

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

The last time that the status of the configuration change was updated.

PendingProperties

Type: Array of strings

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

StartTime

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

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

Status

Type: string

The overall status of the domain configuration change.

TotalNumberOfStages

Type: int

The total number of stages required for the configuration change.

ClusterConfig

Description

Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

Members

ColdStorageOptions

Type: ColdStorageOptions structure

Container for cold storage configuration options.

DedicatedMasterCount

Type: int

Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.

DedicatedMasterEnabled

Type: boolean

Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

DedicatedMasterType

Type: string

OpenSearch Service instance type of the dedicated master nodes in the cluster.

InstanceCount

Type: int

Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

InstanceType

Type: string

Instance type of data nodes in the cluster.

MultiAZWithStandbyEnabled

Type: boolean

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

WarmCount

Type: int

The number of warm nodes in the cluster.

WarmEnabled

Type: boolean

Whether to enable warm storage for the cluster.

WarmType

Type: string

The instance type for the cluster's warm nodes.

ZoneAwarenessConfig

Type: ZoneAwarenessConfig structure

Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

ZoneAwarenessEnabled

Type: boolean

Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

ClusterConfigStatus

Description

The cluster configuration status for a domain.

Members

Options

Required: Yes
Type: ClusterConfig structure

Cluster configuration options for the specified domain.

Status

Required: Yes
Type: OptionStatus structure

The status of cluster configuration options for the specified domain.

CognitoOptions

Description

Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

Members

Enabled

Type: boolean

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

IdentityPoolId

Type: string

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

RoleArn

Type: string

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

UserPoolId

Type: string

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

CognitoOptionsStatus

Description

The status of the Cognito options for the specified domain.

Members

Options

Required: Yes
Type: CognitoOptions structure

Cognito options for the specified domain.

Status

Required: Yes
Type: OptionStatus structure

The status of the Cognito options for the specified domain.

ColdStorageOptions

Description

Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see Cold storage for Amazon OpenSearch Service.

Members

Enabled

Required: Yes
Type: boolean

Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.

CompatibleVersionsMap

Description

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

Members

SourceVersion

Type: string

The current version that the OpenSearch Service domain is running.

TargetVersions

Type: Array of strings

The possible versions that you can upgrade the domain to.

ConflictException

Description

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

Members

ConnectionProperties

Description

The connection properties of an outbound connection.

Members

CrossClusterSearch

Type: CrossClusterSearchConnectionProperties structure

The connection properties for cross cluster search.

Endpoint

Type: string

The Endpoint attribute cannot be modified.

The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.

CrossClusterSearchConnectionProperties

Description

Cross-cluster search specific connection properties.

Members

SkipUnavailable

Type: string

The status of the SkipUnavailable setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters.

DataSourceDetails

Description

Details about a direct-query data source.

Members

DataSourceType

Type: DataSourceType structure

The type of data source.

Description

Type: string

A description of the data source.

Name

Type: string

The name of the data source.

Status

Type: string

The status of the data source.

DataSourceType

Description

The type of data source.

Members

S3GlueDataCatalog

Type: S3GlueDataCatalog structure

An Amazon S3 data source.

DependencyFailureException

Description

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

Members

DescribePackagesFilter

Description

A filter to apply to the DescribePackage response.

Members

Name

Type: string

Any field from PackageDetails.

Value

Type: Array of strings

A non-empty list of values for the specified filter field.

DisabledOperationException

Description

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

Members

DomainConfig

Description

Container for the configuration of an OpenSearch Service domain.

Members

AccessPolicies

Type: AccessPoliciesStatus structure

Specifies the access policies for the domain.

AdvancedOptions

Type: AdvancedOptionsStatus structure

Key-value pairs to specify advanced configuration options. For more information, see Advanced options.

AdvancedSecurityOptions

Type: AdvancedSecurityOptionsStatus structure

Container for fine-grained access control settings for the domain.

AutoTuneOptions

Type: AutoTuneOptionsStatus structure

Container for Auto-Tune settings for the domain.

ChangeProgressDetails

Type: ChangeProgressDetails structure

Container for information about the progress of an existing configuration change.

ClusterConfig

Type: ClusterConfigStatus structure

Container for the cluster configuration of a the domain.

CognitoOptions

Type: CognitoOptionsStatus structure

Container for Amazon Cognito options for the domain.

DomainEndpointOptions

Type: DomainEndpointOptionsStatus structure

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

EBSOptions

Type: EBSOptionsStatus structure

Container for EBS options configured for the domain.

EncryptionAtRestOptions

Type: EncryptionAtRestOptionsStatus structure

Key-value pairs to enable encryption at rest.

EngineVersion

Type: VersionStatus structure

The OpenSearch or Elasticsearch version that the domain is running.

IPAddressType

Type: IPAddressTypeStatus structure

Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.

LogPublishingOptions

Type: LogPublishingOptionsStatus structure

Key-value pairs to configure log publishing.

ModifyingProperties

Type: Array of ModifyingProperties structures

Information about the domain properties that are currently being modified.

NodeToNodeEncryptionOptions

Type: NodeToNodeEncryptionOptionsStatus structure

Whether node-to-node encryption is enabled or disabled.

OffPeakWindowOptions

Type: OffPeakWindowOptionsStatus structure

Container for off-peak window options for the domain.

SnapshotOptions

Type: SnapshotOptionsStatus structure

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

SoftwareUpdateOptions

Type: SoftwareUpdateOptionsStatus structure

Software update options for the domain.

VPCOptions

Type: VPCDerivedInfoStatus structure

The current VPC options for the domain and the status of any updates to their configuration.

DomainEndpointOptions

Description

Options to configure a custom endpoint for an OpenSearch Service domain.

Members

CustomEndpoint

Type: string

The fully qualified URL for the custom endpoint.

CustomEndpointCertificateArn

Type: string

The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

CustomEndpointEnabled

Type: boolean

Whether to enable a custom endpoint for the domain.

EnforceHTTPS

Type: boolean

True to require that all traffic to the domain arrive over HTTPS.

TLSSecurityPolicy

Type: string

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

Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2
Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2
Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites

DomainEndpointOptionsStatus

Description

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

Members

Options

Required: Yes
Type: DomainEndpointOptions structure

Options to configure the endpoint for a domain.

Status

Required: Yes
Type: OptionStatus structure

The status of the endpoint options for a domain.

DomainInfo

Description

Information about an OpenSearch Service domain.

Members

DomainName

Type: string

Name of the domain.

EngineType

Type: string

The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.

DomainInformationContainer

Description

Container for information about an OpenSearch Service domain.

Members

AWSDomainInformation

Type: AWSDomainInformation structure

Information about an Amazon OpenSearch Service domain.

DomainMaintenanceDetails

Description

Container for the domain maintenance details.

Members

Action

Type: string

The name of the action.

CreatedAt

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

The time at which the action was created.

DomainName

Type: string

The name of the domain.

MaintenanceId

Type: string

The ID of the requested action.

NodeId

Type: string

The ID of the data node.

Status

Type: string

The status of the action.

StatusMessage

Type: string

The status message for the action.

UpdatedAt

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

The time at which the action was updated.

DomainNodesStatus

Description

Container for information about nodes on the domain.

Members

AvailabilityZone

Type: string

The Availability Zone of the node.

InstanceType

Type: string

The instance type information of the node.

NodeId

Type: string

The ID of the node.

NodeStatus

Type: string

Indicates if the node is active or in standby.

NodeType

Type: string

Indicates whether the nodes is a data, master, or ultrawarm node.

StorageSize

Type: string

The storage size of the node, in GiB.

StorageType

Type: string

Indicates if the node has EBS or instance storage.

StorageVolumeType

Type: string

If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only applicable for data nodes.

DomainPackageDetails

Description

Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.

Members

DomainName

Type: string

Name of the domain that the package is associated with.

DomainPackageStatus

Type: string

State of the association.

ErrorDetails

Type: ErrorDetails structure

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

LastUpdated

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

Timestamp of the most recent update to the package association status.

PackageID

Type: string

Internal ID of the package.

PackageName

Type: string

User-specified name of the package.

PackageType

Type: string

The type of package.

PackageVersion

Type: string

The current version of the package.

ReferencePath

Type: string

The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.

DomainStatus

Description

The current status of an OpenSearch Service domain.

Members

ARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

AccessPolicies

Type: string

Identity and Access Management (IAM) policy document specifying the access policies for the domain.

AdvancedOptions

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

Key-value pairs that specify advanced configuration options.

AdvancedSecurityOptions

Type: AdvancedSecurityOptions structure

Settings for fine-grained access control.

AutoTuneOptions

Type: AutoTuneOptionsOutput structure

Auto-Tune settings for the domain.

ChangeProgressDetails

Type: ChangeProgressDetails structure

Information about a configuration change happening on the domain.

ClusterConfig

Required: Yes
Type: ClusterConfig structure

Container for the cluster configuration of the domain.

CognitoOptions

Type: CognitoOptions structure

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

Created

Type: boolean

Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

Deleted

Type: boolean

Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

DomainEndpointOptions

Type: DomainEndpointOptions structure

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

DomainEndpointV2HostedZoneId

Type: string

The dual stack hosted zone ID for the domain.

DomainId

Required: Yes
Type: string

Unique identifier for the domain.

DomainName

Required: Yes
Type: string

Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

DomainProcessingStatus

Type: string

The status of any changes that are currently in progress for the domain.

EBSOptions

Type: EBSOptions structure

Container for EBS-based storage settings for the domain.

EncryptionAtRestOptions

Type: EncryptionAtRestOptions structure

Encryption at rest settings for the domain.

Endpoint

Type: string

Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

EndpointV2

Type: string

If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

Endpoints

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

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:

IPv4 IP addresses - 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
Dual stack IP addresses - 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'

EngineVersion

Type: string

Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

IPAddressType

Type: string

The type of IP addresses supported by the endpoint for the domain.

LogPublishingOptions

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

Log publishing options for the domain.

ModifyingProperties

Type: Array of ModifyingProperties structures

Information about the domain properties that are currently being modified.

NodeToNodeEncryptionOptions

Type: NodeToNodeEncryptionOptions structure

Whether node-to-node encryption is enabled or disabled.

OffPeakWindowOptions

Type: OffPeakWindowOptions structure

Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

Processing

Type: boolean

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

ServiceSoftwareOptions

Type: ServiceSoftwareOptions structure

The current status of the domain's service software.

SnapshotOptions

Type: SnapshotOptions structure

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

SoftwareUpdateOptions

Type: SoftwareUpdateOptions structure

Service software update options for the domain.

UpgradeProcessing

Type: boolean

The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

VPCOptions

Type: VPCDerivedInfo structure

The VPC configuration for the domain.

DryRunProgressStatus

Description

Information about the progress of a pre-upgrade dry run analysis.

Members

CreationDate

Required: Yes
Type: string

The timestamp when the dry run was initiated.

DryRunId

Required: Yes
Type: string

The unique identifier of the dry run.

DryRunStatus

Required: Yes
Type: string

The current status of the dry run.

UpdateDate

Required: Yes
Type: string

The timestamp when the dry run was last updated.

ValidationFailures

Type: Array of ValidationFailure structures

Any validation failures that occurred as a result of the dry run.

DryRunResults

Description

Results of a dry run performed in an update domain request.

Members

DeploymentType

Type: string

Specifies the way in which OpenSearch Service will apply an update. Possible values are:

Blue/Green - The update requires a blue/green deployment.
DynamicUpdate - No blue/green deployment required
Undetermined - The domain is in the middle of an update and can't predict the deployment type. Try again after the update is complete.
None - The request doesn't include any configuration changes.

Message

Type: string

A message corresponding to the deployment type.

Duration

Description

The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

Members

Unit

Type: string

The unit of measurement for the duration of a maintenance schedule.

Value

Type: long (int|float)

Integer to specify the value of a maintenance schedule duration.

EBSOptions

Description

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

Members

EBSEnabled

Type: boolean

Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

Iops

Type: int

Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

Throughput

Type: int

Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

VolumeSize

Type: int

Specifies the size (in GiB) of EBS volumes attached to data nodes.

VolumeType

Type: string

Specifies the type of EBS volumes attached to data nodes.

EBSOptionsStatus

Description

The status of the EBS options for the specified OpenSearch Service domain.

Members

Options

Required: Yes
Type: EBSOptions structure

The configured EBS options for the specified domain.

Status

Required: Yes
Type: OptionStatus structure

The status of the EBS options for the specified domain.

EncryptionAtRestOptions

Description

Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at rest for the first time on an existing domain. You can't modify this parameter after it's already been specified.

Members

Enabled

Type: boolean

True to enable encryption at rest.

KmsKeyId

Type: string

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

EncryptionAtRestOptionsStatus

Description

Status of the encryption at rest options for the specified OpenSearch Service domain.

Members

Options

Required: Yes
Type: EncryptionAtRestOptions structure

Encryption at rest options for the specified domain.

Status

Required: Yes
Type: OptionStatus structure

The status of the encryption at rest options for the specified domain.

EnvironmentInfo

Description

Information about the active domain environment.

Members

AvailabilityZoneInformation

Type: Array of AvailabilityZoneInfo structures

A list of AvailabilityZoneInfo for the domain.

ErrorDetails

Description

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

Members

ErrorMessage

Type: string

A message describing the error.

ErrorType

Type: string

The type of error that occurred.

Filter

Description

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

Members

Name

Type: string

The name of the filter.

Values

Type: Array of strings

One or more values for the filter.

IPAddressTypeStatus

Description

The IP address type status for the domain.

Members

Options

Required: Yes
Type: string

The IP address options for the domain.

Status

Required: Yes
Type: OptionStatus structure

Provides the current status of an entity.

InboundConnection

Description

Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Members

ConnectionId

Type: string

The unique identifier of the connection.

ConnectionMode

Type: string

The connection mode.

ConnectionStatus

Type: InboundConnectionStatus structure

The current status of the connection.

LocalDomainInfo

Type: DomainInformationContainer structure

Information about the source (local) domain.

RemoteDomainInfo

Type: DomainInformationContainer structure

Information about the destination (remote) domain.

InboundConnectionStatus

Description

The status of an inbound cross-cluster connection for OpenSearch Service.

Members

Message

Type: string

Information about the connection.

StatusCode

Type: string

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

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

InstanceCountLimits

Description

Limits on the number of instances that can be created in OpenSearch Service for a given instance type.

Members

MaximumInstanceCount

Type: int

The minimum allowed number of instances.

MinimumInstanceCount

Type: int

The maximum allowed number of instances.

InstanceLimits

Description

Instance-related attributes that are available for a given instance type.

Members

InstanceCountLimits

Type: InstanceCountLimits structure

Limits on the number of instances that can be created for a given instance type.

InstanceTypeDetails

Description

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

Members

AdvancedSecurityEnabled

Type: boolean

Whether fine-grained access control is supported for the instance type.

AppLogsEnabled

Type: boolean

Whether logging is supported for the instance type.

AvailabilityZones

Type: Array of strings

The supported Availability Zones for the instance type.

CognitoEnabled

Type: boolean

Whether Amazon Cognito access is supported for the instance type.

EncryptionEnabled

Type: boolean

Whether encryption at rest and node-to-node encryption are supported for the instance type.

InstanceRole

Type: Array of strings

Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.

InstanceType

Type: string

The instance type.

WarmEnabled

Type: boolean

Whether UltraWarm is supported for the instance type.

InternalException

Description

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

Members

InvalidPaginationTokenException

Description

Request processing failed because you provided an invalid pagination token.

Members

InvalidTypeException

Description

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

Members

LimitExceededException

Description

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

Members

Limits

Description

Limits for a given instance type and for each of its roles.

Members

AdditionalLimits

Type: Array of AdditionalLimit structures

List of additional limits that are specific to a given instance type for each of its instance roles.

InstanceLimits

Type: InstanceLimits structure

The limits for a given instance type.

StorageTypes

Type: Array of StorageType structures

Storage-related attributes that are available for a given instance type.

LogPublishingOption

Description

Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs.

After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

Members

CloudWatchLogsLogGroupArn

Type: string

The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

Enabled

Type: boolean

Whether the log should be published.

LogPublishingOptionsStatus

Description

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

Members

Options

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

The log publishing options configured for the domain.

Status

Type: OptionStatus structure

The status of the log publishing options for the domain.

MasterUserOptions

Description

Credentials for the master user for a domain.

Members

MasterUserARN

Type: string

Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false.

MasterUserName

Type: string

User name for the master user. Only specify if InternalUserDatabaseEnabled is true.

MasterUserPassword

Type: string

Password for the master user. Only specify if InternalUserDatabaseEnabled is true.

ModifyingProperties

Description

Information about the domain properties that are currently being modified.

Members

ActiveValue

Type: string

The current value of the domain property that is being modified.

Name

Type: string

The name of the property that is currently being modified.

PendingValue

Type: string

The value that the property that is currently being modified will eventually have.

ValueType

Type: string

The type of value that is currently being modified. Properties can have two types:

PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search".
STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".

NodeToNodeEncryptionOptions

Description

Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service.

Members

Enabled

Type: boolean

True to enable node-to-node encryption.

NodeToNodeEncryptionOptionsStatus

Description

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

Members

Options

Required: Yes
Type: NodeToNodeEncryptionOptions structure

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

Status

Required: Yes
Type: OptionStatus structure

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

OffPeakWindow

Description

A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain. These actions can include scheduled service software updates and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these actions during the window that you specify.

If you don't specify a window start time, it defaults to 10:00 P.M. local time.

For more information, see Defining off-peak maintenance windows for Amazon OpenSearch Service.

Members

WindowStartTime

Type: WindowStartTime structure

A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

OffPeakWindowOptions

Description

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

Members

Enabled

Type: boolean

Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

OffPeakWindow

Type: OffPeakWindow structure

Off-peak window settings for the domain.

OffPeakWindowOptionsStatus

Description

The status of off-peak window options for a domain.

Members

Options

Type: OffPeakWindowOptions structure

The domain's off-peak window configuration.

Status

Type: OptionStatus structure

The current status of off-peak window options.

OptionStatus

Description

Provides the current status of an entity.

Members

CreationDate

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

The timestamp when the entity was created.

PendingDeletion

Type: boolean

Indicates whether the entity is being deleted.

State

Required: Yes
Type: string

The state of the entity.

UpdateDate

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

The timestamp of the last time the entity was updated.

UpdateVersion

Type: int

The latest version of the entity.

OutboundConnection

Description

Specifies details about an outbound cross-cluster connection.

Members

ConnectionAlias

Type: string

Name of the connection.

ConnectionId

Type: string

Unique identifier of the connection.

ConnectionMode

Type: string

The connection mode.

ConnectionProperties

Type: ConnectionProperties structure

Properties for the outbound connection.

ConnectionStatus

Type: OutboundConnectionStatus structure

Status of the connection.

LocalDomainInfo

Type: DomainInformationContainer structure

Information about the source (local) domain.

RemoteDomainInfo

Type: DomainInformationContainer structure

Information about the destination (remote) domain.

OutboundConnectionStatus

Description

The status of an outbound cross-cluster connection.

Members

Message

Type: string

Verbose information for the outbound connection.

StatusCode

Type: string

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

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

PackageDetails

Description

Basic information about a package.

Members

AvailablePackageVersion

Type: string

The package version.

AvailablePluginProperties

Type: PluginProperties structure

If the package is a ZIP-PLUGIN package, additional information about plugin properties.

CreatedAt

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

The timestamp when the package was created.

EngineVersion

Type: string

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

ErrorDetails

Type: ErrorDetails structure

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

LastUpdatedAt

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

Date and time when the package was last updated.

PackageDescription

Type: string

User-specified description of the package.

PackageID

Type: string

The unique identifier of the package.

PackageName

Type: string

The user-specified name of the package.

PackageStatus

Type: string

The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

PackageType

Type: string

The type of package.

PackageSource

Description

The Amazon S3 location to import the package from.

Members

S3BucketName

Type: string

The name of the Amazon S3 bucket containing the package.

S3Key

Type: string

Key (file name) of the package.

PackageVersionHistory

Description

Details about a package version.

Members

CommitMessage

Type: string

A message associated with the package version when it was uploaded.

CreatedAt

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

The date and time when the package was created.

PackageVersion

Type: string

The package version.

PluginProperties

Type: PluginProperties structure

Additional information about plugin properties if the package is a ZIP-PLUGIN package.

PluginProperties

Description

Basic information about the plugin.

Members

ClassName

Type: string

The name of the class to load.

Description

Type: string

The description of the plugin.

Name

Type: string

The name of the plugin.

UncompressedSizeInBytes

Type: long (int|float)

The uncompressed size of the plugin.

Version

Type: string

The version of the plugin.

RecurringCharge

Description

Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.

Members

RecurringChargeAmount

Type: double

The monetary amount of the recurring charge.

RecurringChargeFrequency

Type: string

The frequency of the recurring charge.

ReservedInstance

Description

Details of an OpenSearch Reserved Instance.

Members

BillingSubscriptionId

Type: long (int|float)

The unique identifier of the billing subscription.

CurrencyCode

Type: string

The currency code for the offering.

Duration

Type: int

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

FixedPrice

Type: double

The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.

InstanceCount

Type: int

The number of OpenSearch instances that have been reserved.

InstanceType

Type: string

The OpenSearch instance type offered by theReserved Instance offering.

PaymentOption

Type: string

The payment option as defined in the Reserved Instance offering.

RecurringCharges

Type: Array of RecurringCharge structures

The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.

ReservationName

Type: string

The customer-specified identifier to track this reservation.

ReservedInstanceId

Type: string

The unique identifier for the reservation.

ReservedInstanceOfferingId

Type: string

The unique identifier of the Reserved Instance offering.

StartTime

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

The date and time when the reservation was purchased.

State

Type: string

The state of the Reserved Instance.

UsagePrice

Type: double

The hourly rate at which you're charged for the domain using this Reserved Instance.

ReservedInstanceOffering

Description

Details of an OpenSearch Reserved Instance offering.

Members

CurrencyCode

Type: string

The currency code for the Reserved Instance offering.

Duration

Type: int

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

FixedPrice

Type: double

The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.

InstanceType

Type: string

The OpenSearch instance type offered by the Reserved Instance offering.

PaymentOption

Type: string

Payment option for the Reserved Instance offering

RecurringCharges

Type: Array of RecurringCharge structures

The recurring charge to your account, regardless of whether you creates any domains using the offering.

ReservedInstanceOfferingId

Type: string

The unique identifier of the Reserved Instance offering.

UsagePrice

Type: double

The hourly rate at which you're charged for the domain using this Reserved Instance.

ResourceAlreadyExistsException

Description

An exception for creating a resource that already exists.

Members

ResourceNotFoundException

Description

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

Members

S3GlueDataCatalog

Description

Information about the Amazon S3 Glue Data Catalog.

Members

RoleArn

Type: string

>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.

SAMLIdp

Description

The SAML identity povider information.

Members

EntityId

Required: Yes
Type: string

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

MetadataContent

Required: Yes
Type: string

The metadata of the SAML application, in XML format.

SAMLOptionsInput

Description

The SAML authentication configuration for an Amazon OpenSearch Service domain.

Members

Enabled

Type: boolean

True to enable SAML authentication for a domain.

Idp

Type: SAMLIdp structure

The SAML Identity Provider's information.

MasterBackendRole

Type: string

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

MasterUserName

Type: string

The SAML master user name, which is stored in the domain's internal user database.

RolesKey

Type: string

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

SessionTimeoutMinutes

Type: int

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

SubjectKey

Type: string

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

SAMLOptionsOutput

Description

Describes the SAML application configured for the domain.

Members

Enabled

Type: boolean

True if SAML is enabled.

Idp

Type: SAMLIdp structure

Describes the SAML identity provider's information.

RolesKey

Type: string

The key used for matching the SAML roles attribute.

SessionTimeoutMinutes

Type: int

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

SubjectKey

Type: string

The key used for matching the SAML subject attribute.

ScheduledAction

Description

Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software update or a blue/green Auto-Tune enhancement.

Members

Cancellable

Type: boolean

Whether or not the scheduled action is cancellable.

Description

Type: string

A description of the action to be taken.

Id

Required: Yes
Type: string

The unique identifier of the scheduled action.

Mandatory

Type: boolean

Whether the action is required or optional.

ScheduledBy

Type: string

Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically (SYSTEM).

ScheduledTime

Required: Yes
Type: long (int|float)

The time when the change is scheduled to happen.

Severity

Required: Yes
Type: string

The severity of the action.

Status

Type: string

The current status of the scheduled action.

Type

Required: Yes
Type: string

The type of action that will be taken on the domain.

ScheduledAutoTuneDetails

Description

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

Members

Action

Type: string

A description of the Auto-Tune action.

ActionType

Type: string

The type of Auto-Tune action.

Date

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

The date and time when the Auto-Tune action is scheduled for the domain.

Severity

Type: string

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

ServiceSoftwareOptions

Description

The current status of the service software for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

Members

AutomatedUpdateDate

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

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

Cancellable

Type: boolean

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

CurrentVersion

Type: string

The current service software version present on the domain.

Description

Type: string

A description of the service software update status.

NewVersion

Type: string

The new service software version, if one is available.

OptionalDeployment

Type: boolean

True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

UpdateAvailable

Type: boolean

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

UpdateStatus

Type: string

The status of your service software update.

SlotNotAvailableException

Description

An exception for attempting to schedule a domain action during an unavailable time slot.

Members

SlotSuggestions

Type: Array of long (int|float)s

Alternate time slots during which OpenSearch Service has available capacity to schedule a domain action.

SnapshotOptions

Description

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

Members

AutomatedSnapshotStartHour

Type: int

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

SnapshotOptionsStatus

Description

Container for information about a daily automated snapshot for an OpenSearch Service domain.

Members

Options

Required: Yes
Type: SnapshotOptions structure

The daily snapshot options specified for the domain.

Status

Required: Yes
Type: OptionStatus structure

The status of a daily automated snapshot.

SoftwareUpdateOptions

Description

Options for configuring service software updates for a domain.

Members

AutoSoftwareUpdateEnabled

Type: boolean

Whether automatic service software updates are enabled for the domain.

SoftwareUpdateOptionsStatus

Description

The status of the service software options for a domain.

Members

Options

Type: SoftwareUpdateOptions structure

The service software update options for a domain.

Status

Type: OptionStatus structure

The status of service software update options, including creation date and last updated date.

StorageType

Description

A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type.

Members

StorageSubTypeName

Type: string

The storage sub-type, such as gp3 or io1.

StorageTypeLimits

Type: Array of StorageTypeLimit structures

Limits that are applicable for the given storage type.

StorageTypeName

Type: string

The name of the storage type.

StorageTypeLimit

Description

Limits that are applicable for the given Amazon OpenSearch Service storage type.

Members

LimitName

Type: string

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

MinimumVolumeSize - Minimum volume size that is available for the given storage type. Can be empty if not applicable.
MaximumVolumeSize - Maximum volume size that is available for the given storage type. Can be empty if not applicable.
MaximumIops - Maximum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
MinimumIops - Minimum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
MaximumThroughput - Maximum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
MinimumThroughput - Minimum amount of throughput that is available for the given the storage type. Can be empty if not applicable.

LimitValues

Type: Array of strings

The limit values.

Tag

Description

A tag (key-value pair) for an Amazon OpenSearch Service resource.

Members

Key

Required: Yes
Type: string

The tag key. Tag keys must be unique for the domain to which they are attached.

Value

Required: Yes
Type: string

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

UpgradeHistory

Description

History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.

Members

StartTimestamp

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

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

StepsList

Type: Array of UpgradeStepItem structures

A list of each step performed as part of a specific upgrade or upgrade eligibility check.

UpgradeName

Type: string

A string that describes the upgrade.

UpgradeStatus

Type: string

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

In Progress
Succeeded
Succeeded with Issues
Failed

UpgradeStepItem

Description

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

Members

Issues

Type: Array of strings

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

ProgressPercent

Type: double

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

UpgradeStep

Type: string

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

PreUpgradeCheck
Snapshot
Upgrade

UpgradeStepStatus

Type: string

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

In Progress
Succeeded
Succeeded with Issues
Failed

VPCDerivedInfo

Description

Information about the subnets and security groups for an Amazon OpenSearch Service domain provisioned within a virtual private cloud (VPC). For more information, see Launching your Amazon OpenSearch Service domains using a VPC. This information only exists if the domain was created with VPCOptions.

Members

AvailabilityZones

Type: Array of strings

The list of Availability Zones associated with the VPC subnets.

SecurityGroupIds

Type: Array of strings

The list of security group IDs associated with the VPC endpoints for the domain.

SubnetIds

Type: Array of strings

A list of subnet IDs associated with the VPC endpoints for the domain.

VPCId

Type: string

The ID for your VPC. Amazon VPC generates this value when you create a VPC.

VPCDerivedInfoStatus

Description

Status of the VPC options for a specified domain.

Members

Options

Required: Yes
Type: VPCDerivedInfo structure

The VPC options for the specified domain.

Status

Required: Yes
Type: OptionStatus structure

The status of the VPC options for the specified domain.

VPCOptions

Description

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

Members

SecurityGroupIds

Type: Array of strings

The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

SubnetIds

Type: Array of strings

A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

ValidationException

Description

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

Members

ValidationFailure

Description

A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain.

Members

Code

Type: string

The error code of the failure.

Message

Type: string

A message corresponding to the failure.

VersionStatus

Description

The status of the the OpenSearch or Elasticsearch version options for the specified Amazon OpenSearch Service domain.

Members

Options

Required: Yes
Type: string

The OpenSearch or Elasticsearch version for the specified domain.

Status

Required: Yes
Type: OptionStatus structure

The status of the version options for the specified domain.

VpcEndpoint

Description

The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.

Members

DomainArn

Type: string

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

Endpoint

Type: string

The connection endpoint ID for connecting to the domain.

Status

Type: string

The current status of the endpoint.

VpcEndpointId

Type: string

The unique identifier of the endpoint.

VpcEndpointOwner

Type: string

The creator of the endpoint.

VpcOptions

Type: VPCDerivedInfo structure

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

VpcEndpointError

Description

Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.

Members

ErrorCode

Type: string

The code associated with the error.

ErrorMessage

Type: string

A message describing the error.

VpcEndpointId

Type: string

The unique identifier of the endpoint.

VpcEndpointSummary

Description

Summary information for an Amazon OpenSearch Service-managed VPC endpoint.

Members

DomainArn

Type: string

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

Status

Type: string

The current status of the endpoint.

VpcEndpointId

Type: string

The unique identifier of the endpoint.

VpcEndpointOwner

Type: string

The creator of the endpoint.

WindowStartTime

Description

The desired start time for an off-peak maintenance window.

Members

Hours

Required: Yes
Type: long (int|float)

The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

Minutes

Required: Yes
Type: long (int|float)

The start minute of the window, in UTC.

ZoneAwarenessConfig

Description

The zone awareness configuration for an Amazon OpenSearch Service domain.

Members

AvailabilityZoneCount

Type: int

If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.

Amazon OpenSearch Service 2021-01-01

Operation Summary

Paginators

Operations

AcceptInboundConnection

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddDataSource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddTags

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociatePackage

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AuthorizeVpcEndpointAccess

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CancelDomainConfigChange

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CancelServiceSoftwareUpdate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDomain

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateOutboundConnection

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreatePackage

Parameter Syntax

Parameter Details

Members

Result Syntax