Referência da API de configuração para o Amazon OpenSearch Service - Amazon OpenSearch Service

Referência da API de configuração para o Amazon OpenSearch Service

Essa referência descreve as ações, os tipos de dados e os erros na API de configuração do Amazon OpenSearch Service. A API de configuração é uma API REST que pode ser usada para criar e configurar domínios do OpenSearch Service em HTTP. Além disso, é possível usar a AWS CLI e o console para configurar domínios do OpenSearch Service. Para mais informações, consulte Criação e gerenciamento de domínios do Amazon OpenSearch Service.

Autenticação

Todas as solicitações de serviço de configuração devem ser assinadas. Para obter mais informações, consulte Assinatura de solicitações do Amazon OpenSearch Service neste guia e Signature Version 4 signing process (Processo de assinatura com o Signature Version 4) na Referência geral da AWS.

Nova versão da API e ações defasadas

Importante

As ações a seguir tornaram-se defasadas na versão 2021-01-01 da API do Amazon OpenSearch Service e foram substituídas por endpoints mais concisos e independentes de mecanismo. No entanto, a AWS CLI e a API de configuração continuam a aceitá-los.

Ação defasada Substituição
AcceptInboundCrossClusterSearchConnection AcceptInboundConnection
CreateElasticsearchDomain CreateDomain
CreateOutboundCrossClusterSearchConnection CreateOutboundConnection
CreateElasticsearchServiceRole Sem substituição. Use a API do IAM para criar funções vinculadas ao serviço.
DeleteElasticsearchDomain DeleteDomain
DeleteElasticsearchServiceRole Sem substituição. Use a API do IAM para excluir funções vinculadas ao serviço.
DeleteInboundCrossClusterSearchConnection DeleteInboundConnection
DescribeElasticsearchDomain DescribeDomain
DescribeElasticsearchDomainConfig DescribeDomainConfig
DescribeElasticsearchInstanceTypeLimits DescribeInstanceTypeLimits
DescribeInboundCrossClusterSearchConnections DescribeInboundConnections
DescribeOutboundCrossClusterSearchConnections DescribeOutboundConnections
DescribeReservedElasticsearchInstanceOfferings DescribeReservedInstanceOfferings
DescribeReservedElasticsearchInstances DescribeReservedInstances
GetCompatibleElasticsearchVersions GetCompatibleVersions
ListElasticsearchInstanceTypeDetails ListInstanceTypeDetails
ListElasticsearchVersions ListVersions
PurchaseReservedElasticsearchInstanceOffering PurchaseReservedInstanceOffering
RejectInboundCrossClusterSearchConnection RejectInboundConnection
StartElasticsearchServiceSoftwareUpdate StartServiceSoftwareUpdate
StopElasticsearchServiceSoftwareUpdate StopServiceSoftwareUpdate
UpdateElasticsearchDomainConfig UpdateDomainConfig
UpgradeElasticsearchDomain UpgradeDomain

Ações

A tabela a seguir fornece uma referência rápida sobre o método HTTP exigido por cada operação para a interface REST com a API de configuração do Amazon OpenSearch Service. A descrição de cada operação também inclui o método HTTP necessário.

AcceptInboundConnection

Permite que o proprietário do domínio de destino aceite uma solicitação de conexão de pesquisa entre clusters de entrada.

Sintaxe

PUT https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/inboundConnection/connection-id/accept

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação HTTP.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
CrossClusterSearchConnection Objeto Detalhes da conexão de entrada.

AddTags

Anexa tags de recurso a um domínio do OpenSearch Service. Para mais informações, consulte Marcação de domínios do Amazon OpenSearch Service.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/tags { "ARN": "domain-arn", "TagList": [{ "Key": "tag-key", "Value": "tag-value" }] }

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação.

Corpo da solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
TagList TagList Sim Lista de tags de recurso.
ARN ARN Sim Nome do recurso da Amazon (ARN) para o domínio do OpenSearch Service ao qual você deseja anexar tags de recurso.

Elementos de resposta

A operação AddTags não retorna uma estrutura de dados.

AssociatePackage

Associa um pacote a um domínio do OpenSearch Service.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/packages/associate/package-id/domain-name

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
PackageID String Sim ID interno do pacote que você deseja associar a um domínio. Use DescribePackages para localizar esse valor.
DomainName DomainName Sim Nome do domínio ao qual você deseja associar o pacote.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados
DomainPackageDetails DomainPackageDetails

CreateDomain

Cria um domínio do OpenSearch Service. Para mais informações, consulte Criação de domínios do OpenSearch Service.

nota

Se você tentar criar um domínio do OpenSearch Service e um domínio com o nome de um domínio que já existe, a API não relatará um erro. Em vez disso, ela retornará detalhes do domínio existente.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain { "ClusterConfig": { "ZoneAwarenessConfig": { "AvailabilityZoneCount": 3 }, "ZoneAwarenessEnabled": true|false, "InstanceCount": 3, "DedicatedMasterEnabled": true|false, "DedicatedMasterType": "c5.large.search", "DedicatedMasterCount": 3, "InstanceType": "r5.large.search", "WarmCount": 3, "WarmEnabled": true|false, "WarmType": "ultrawarm1.large.search", "ColdStorageOptions": { "Enabled": true|false }, "EBSOptions": { "EBSEnabled": true|false, "VolumeType": "gp3|gp2|io1|standard", "VolumeSize": 10, "Iops": 3000, "Throughput": 125 }, "EncryptionAtRestOptions": { "Enabled": true|false, "KmsKeyId":"arn:aws:kms:us-east-1:123456789012:alias/my-key" }, "VPCOptions": { "VPCId": "vpc-12345678", "SubnetIds": ["subnet-abcdefg1", "subnet-abcdefg2", "subnet-abcdefg3"], "SecurityGroupIds": ["sg-12345678"] }, "AdvancedOptions": { "rest.action.multi.allow_explicit_index": "true|false", "indices.fielddata.cache.size": "40", "indices.query.bool.max_clause_count": "1024", "override_main_response_version": "true|false" }, "CognitoOptions": { "Enabled": true|false, "UserPoolId": "us-east-1_121234567", "IdentityPoolId": "us-east-1:12345678-1234-1234-1234-123456789012", "RoleArn": "arn:aws:iam::123456789012:role/service-role/CognitoAccessForAmazonOpenSearch" }, "NodeToNodeEncryptionOptions": { "Enabled": true|false }, "DomainEndpointOptions": { "EnforceHTTPS": true|false, "TLSSecurityPolicy": "Policy-Min-TLS-1-2-2019-07|Policy-Min-TLS-1-0-2019-07", "CustomEndpointEnabled": "true|false", "CustomEndpoint": "www.my-custom-endpoint.com", "CustomEndpointCertificateArn": "arn:aws:iam::123456789012:certificate/my-certificate" }, "LogPublishingOptions": { "SEARCH_SLOW_LOGS": { "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group1:sample-domain", "Enabled":true|false }, "INDEX_SLOW_LOGS": { "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group2:sample-domain", "Enabled":true|false }, "ES_APPLICATION_LOGS": { "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group3:sample-domain", "Enabled":true|false } }, "AdvancedSecurityOptions": { "Enabled": true|false, "InternalUserDatabaseEnabled": true|false, "MasterUserOptions": { "MasterUserARN": "arn:aws:iam::123456789012:role/my-master-user-role" "MasterUserName": "my-master-username", "MasterUserPassword": "my-master-password" } }, "AutoTuneOptions": { "DesiredState": "ENABLED|DISABLED", "MaintenanceSchedules": [{ "StartAt": 1234567890, "Duration": { "Value": 2, "Unit": "HOURS" }, "CronExpressionForRecurrence": "cron(0 0 ? * 3 *)" }] }, "TagList": [ { "Key": "stack", "Value": "prod" } ], "EngineVersion": "OpenSearch_1.0", "DomainName": "my-domain", "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"123456789012\"]},\"Action\":[\"esListDomainNames:ESHttp*\"],\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/my-domain/*\"}]}" }

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação HTTP.

Corpo da solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
DomainName DomainName Sim Nome do domínio do OpenSearch Service a ser criado.
EngineVersion String Não Versão do OpenSearch ou Elasticsearch, no formato Elasticsearch_X.Y ou OpenSearch_x.y. O padrão é a versão mais recente do OpenSearch. Para obter a lista completa de versões compatíveis, consulte Versões compatíveis do OpenSearch e do Elasticsearch..
ClusterConfig ClusterConfig Não Contêiner para a configuração de cluster de um domínio do OpenSearch Service.
EBSOptions EBSOptions Não Contêiner para os parâmetros necessários para habilitar o armazenamento baseado em EBS para um domínio do OpenSearch Service.
VPCOptions VPCOptions Não Contêiner dos valores necessários para configurar os domínios de acesso da VPC. Se você não especificar esses valores, o OpenSearch Service criará o domínio com um endpoint público. Para saber mais, consulte Como iniciar seus domínios do Amazon OpenSearch Service em uma VPC.
CognitoOptions CognitoOptions Não Pares de chave/valor para configurar o OpenSearch Service para usar a autenticação do Amazon Cognito para o OpenSearch Dashboards.
AccessPolicies String Não Documento de política do IAM que especifica políticas de acesso para o novo domínio do OpenSearch Service. Para mais informações, consulte Gerenciamento de identidade e acesso no Amazon OpenSearch Service.
SnapshotOptions SnapshotOptions Não

SUSPENSO. Contêiner para os parâmetros necessários para configurar snapshots automatizados de índices de domínio.

AdvancedOptions AdvancedOptions Não Pares de chave/valor para especificar opções de configuração avançada. Para mais informações, consulte Configurações avançadas do cluster.
LogPublishingOptions Opções de publicação de logs Não de pares de chave-valor para configurar a publicação de logs lentos.
EncryptionAtRestOptions EncryptionAtRestOptions Não Pares de chave-valor para ativar a criptografia em repouso.
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions Não Habilita a criptografia de nó a nó.
DomainEndpointOptions DomainEndpointOptions Não Opções adicionais para o endpoint do domínio, como exigir HTTPS para todo o tráfego.
AdvancedSecurityOptions AdvancedSecurityOptions Não Opções para controle de acesso refinado.
AutoTuneOptions AutoTuneOptions Não Opções para Auto-Tune.
TagList TagList Não Lista de tags que você deseja adicionar ao domínio da criação.

Elementos de resposta

Campo Tipo de dados
DomainStatus DomainStatus

CreateOutboundConnection

Cria uma conexão de pesquisa entre clusters de um domínio de origem para um domínio de destino.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/outboundConnection { "ConnectionAlias":"connection-name", "LocalDomainInfo":{ "AWSDomainInformation":{ "DomainName":"domain-name", "Region":"us-east-1" } }, "RemoteDomainInfo":{ "AWSDomainInformation":{ "OwnerId":"account-id", "DomainName":"domain-name", "Region":"us-east-1" } } }

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação HTTP.

Corpo da solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
ConnectionAlias String Sim O nome da conexão.
LocalDomainInfo Objeto Sim Nome e região do domínio de origem.
RemoteDomainInfo Objeto Sim Nome e região do domínio de destino.

Elementos de resposta

Campo Tipo de dados Descrição
SourceDomainInfo Objeto Nome e região do domínio de origem.
DestinationDomainInfo Objeto Nome e região do domínio de destino.
ConnectionAlias String O nome da conexão.
ConnectionStatus String O status da conexão.
ConnectionId String O ID da conexão de saída.

CreatePackage

Adicione um pacote para uso com domínios do OpenSearch Service.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/packages { "PackageName": "my-package-name", "PackageType": "TXT-DICTIONARY", "PackageDescription": "My synonym file.", "PackageSource": { "S3BucketName": "my-s3-bucket", "S3Key": "synonyms.txt" } }

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação.

Corpo da solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
PackageName String Sim Nome exclusivo do pacote.
PackageType String Sim Tipo de pacote. No momento, oferece suporte apenas a TXT-DICTIONARY.
PackageDescription String Não Descrição do pacote.
PackageSource PackageSource Sim Bucket do S3 e chave do pacote.

Elementos de resposta

Campo Tipo de dados
PackageDetails PackageDetails

CreateElasticsearchServiceRole (defasado)

Cria uma função vinculada ao serviço entre o OpenSearch Service e o Amazon EC2. Essa ação está obsoleta. O OpenSearch Service lida de forma automática com a criação e exclusão de funções vinculadas ao serviço.

Essa função fornece permissões do OpenSearch Service para colocar VPC endpoints em sua VPC. Uma função vinculada ao serviço deve estar em vigor para que domínios com VPC endpoints sejam criados ou funcionem corretamente.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/role

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

A operação CreateServiceRole não retorna uma estrutura de dados.

DeleteDomain

Exclui um domínio do OpenSearch Service e todos os respectivos dados. Não é possível recuperar um domínio após sua exclusão.

Sintaxe

DELETE https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
DomainName DomainName Sim Nome do domínio do OpenSearch Service que você deseja excluir.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados
DomainStatus DomainStatus

DeleteElasticsearchServiceRole (Defasado)

Exclui uma função vinculada ao serviço entre o OpenSearch Service e o Amazon EC2. Essa ação está obsoleta. O OpenSearch Service lida de forma automática com a criação e exclusão de funções.

Essa função fornece permissões do OpenSearch Service para colocar VPC endpoints em sua VPC. Uma função vinculada ao serviço deve estar em vigor para que domínios com VPC endpoints sejam criados ou funcionem corretamente.

nota

Essa ação só funciona se nenhum domínio estiver usando a função vinculada ao serviço.

Sintaxe

DELETE https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/role

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

A operação DeleteElasticsearchServiceRole não retorna uma estrutura de dados.

DeleteInboundConnection

Permite que o proprietário do domínio de destino exclua uma conexão de pesquisa entre clusters de entrada existente.

Sintaxe

DELETE https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/inboundConnection/connection-id

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação HTTP.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
CrossClusterSearchConnection Objeto Detalhes da conexão de entrada.

DeleteOutboundConnection

Permite que o proprietário do domínio de origem exclua uma conexão de pesquisa entre clusters de saída existente.

Sintaxe

DELETE https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/outboundConnection/connection-id

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação HTTP.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
CrossClusterSearchConnection Objeto Detalhes da conexão de saída.

DeletePackage

Exclui um pacote do OpenSearch Service. O pacote não pode ser associado a nenhum domínio do OpenSearch Service.

Sintaxe

DELETE https://es.us-east-1.amazonaws.com/2021-01-01/packages/package-id

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
PackageID String Sim ID interno do pacote que você deseja excluir. Use DescribePackages para localizar esse valor.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados
PackageDetails PackageDetails

DescribeDomainAutoTunes

Retorna a lista de otimizações feitas pelo Auto-Tune para o domínio.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name/autoTunes

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
DomainName DomainName Sim Nome do domínio do OpenSearch Service para o qual você deseja obter detalhes sobre o Auto-Tune.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
AutoTunes List Lista de otimizações.
NextToken String Usado para paginação. Necessário apenas se uma chamada de API anterior tiver produzido um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

DescribeDomain

Descreve a configuração para o domínio do OpenSearch Service especificado, como ID de domínio, endpoint de serviço do domínio e ARN do domínio.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
DomainName DomainName Sim Nome do domínio do OpenSearch Service que você deseja excluir.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados
DomainStatus DomainStatus

DescribeDomainChangeProgress

Exibe informações de status para a alteração de configuração de um domínio.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name/progress

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
DomainName DomainName Sim Nome do domínio do OpenSearch Service.

Corpo da solicitação

Campo Tipo de dados Obrigatório? Descrição
ChangeId String Não O ID da alteração de configuração. Recuperado de uma solicitação UpdateDomainConfig. Se não for especificado, o OpenSearch Service retornará detalhes referentes à alteração de configuração mais recente.

Elementos de resposta

Campo Tipo de dados
ChangeProgressStatus ChangeProgressStatus

DescribeDomainConfig

Exibe a configuração de um domínio do OpenSearch Service.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name/config

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
DomainName DomainName Sim Nome da configuração do domínio do OpenSearch Service que você deseja descrever.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados
DomainConfig DomainConfig

DescribeDomains

Descreve a configuração do domínio para até cinco domínios do OpenSearch Service especificados. As informações incluem ID de domínio, endpoint de serviço do domínio e ARN do domínio.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain-info { "DomainNames": [ "domain-name1", "domain-name2", ] }

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação HTTP.

Corpo da solicitação

Campo Tipo de dados Obrigatório? Descrição
DomainNames DomainNameList Sim Matriz de nomes de domínios do OpenSearch Service.

Elementos de resposta

Campo Tipo de dados
DomainStatusList DomainStatusList

DescribeInstanceTypeLimits

Descreve os limites de número de instâncias, armazenamento e nós principais para uma determinada versão e tipo de instância do OpenSearch ou Elasticsearch.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/instanceTypeLimits/engine-version/instance-type?domainName=domain-name

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
EngineVersion String Sim Versão do OpenSearch ou Elasticsearch, no formato Elasticsearch_X.Y ou OpenSearch_x.y. O padrão é a versão mais recente do OpenSearch. Para obter uma lista completa das versões compatíveis, consulte Versões compatíveis do OpenSearch e do Elasticsearch.. Para ver uma lista das versões com suporte, consulte Versões compatíveis do OpenSearch e do Elasticsearch..
InstanceType String Sim Tipo de instância. Para visualizar tipos de instância por região, consulte Preços do Amazon OpenSearch Service.
DomainName DomainName Não O nome de um domínio existente. Especifique apenas se precisar dos limites para um domínio existente.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
LimitsByRole Mapa Mapa que contém todos os limites de tipo de instância aplicáveis. "data" refere-se a nós de dados. "master" refere-se a nós principais dedicados.

DescribeInboundConnections

Lista todas as conexões de pesquisa entre clusters de entrada para um domínio de destino.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/inboundConnection/search { "Filters": [ { "Name": filter-name (str), "Values" : [val1, val2, ..] (list of strings) }, .... "MaxResults": int (Optional, default value - 100), "NextToken": "next-token-string (optional)" ] }

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação HTTP.

Corpo da solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
Filters Objeto Não Lista de nomes de filtros e valores que você pode usar para as solicitações de descrição. Os seguintes campos são compatíveis: connection-id, local-domain-info.domain-name, local-domain-info.owner-id, local-domain-info.region e remote-domain-info.domain-name.
MaxResults Inteiro Não Limita o número de resultados. O padrão é 100.
NextToken String Não Usado para paginação. Necessário apenas se uma chamada de API anterior tiver produzido um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

Elementos de resposta

Campo Tipo de dados Descrição
CrossClusterSearchConnections Objeto Lista de conexões de entrada.
NextToken String Usado para paginação. Necessário apenas se uma chamada de API anterior tiver produzido um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

DescribeOutboundConnections

Lista todas as conexões de pesquisa entre clusters de saída para um domínio de origem.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/outboundConnection/search { "Filters": [ { "Name": filter-name (str), "Values" : [val1, val2, ..] (list of strings) }, .... "MaxResults": int (Optional, default value - 100), "NextToken": "next-token-string (optional)" ] }

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação HTTP.

Corpo da solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
Filters Objeto Não Lista de nomes de filtros e valores que você pode usar para as solicitações de descrição. Os seguintes campos são compatíveis: connection-id, remote-domain-info.domain-name, remote-domain-info.owner-id, remote-domain-info.region e local-domain-info.domain-name
MaxResults Inteiro Não Limita o número de resultados. O padrão é 100.
NextToken String Não Usado para paginação. Necessário apenas se uma chamada de API anterior tiver produzido um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

Elementos de resposta

Campo Tipo de dados Descrição
CrossClusterSearchConnections Objeto Lista de conexões de saída.
NextToken String Usado para paginação. Necessário apenas se uma chamada de API anterior tiver produzido um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

DescribePackages

Descreve todos os pacotes disponíveis para o OpenSearch Service. Inclui opções de filtragem, limitação do número de resultados e paginação.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/packages/describe { "Filters": [{ "Name": "PackageStatus", "Value": [ "DELETING", "AVAILABLE" ] }], "MaxResults": 5, "NextToken": "next-token", }

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação.

Corpo da solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
Filters Filtros Não Retorna somente pacotes que correspondem aos valores fornecidos.
MaxResults Inteiro Não Limita os resultados a um número máximo de pacotes.
NextToken String Não Usado para paginação. Será necessário apenas se uma chamada de API anterior incluir um valor NextToken não nulo. Se fornecido, retornará resultados para a próxima página.

Elementos de resposta

Campo Tipo de dados Descrição
PackageDetailsList List Lista de objetos PackageDetails.

DescribeReservedInstanceOfferings

Descreve as ofertas de instâncias reservadas disponíveis para determinada região.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/reservedInstanceOfferings?offeringId=offering-id&maxResults=max-results&nextToken=next-token

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
OfferingId String Não O ID da oferta.
MaxResults Inteiro Não Limita o número de resultados. Deve estar entre 30 e 100.
NextToken String Não Usado para paginação. Necessário apenas se uma chamada de API anterior produziu um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
ReservedInstanceOfferings ReservedInstanceOfferings Contêiner de todas as informações sobre uma oferta de instância reservada. Para mais informações, consulte Compra de instâncias reservadas (AWS CLI).

DescribeReservedInstances

Descreve a instância que foi reservada em determinada região.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/reservedInstances?reservationId=reservation-id&maxResults=max-results&nextToken=next-token

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
ReservationId String Não O ID da reserva, atribuído depois que você compra uma reserva.
MaxResults Inteiro Não Limita o número de resultados. Deve estar entre 30 e 100.
NextToken String Não Usado para paginação. Necessário apenas se uma chamada de API anterior produziu um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
ReservedInstances

ReservedInstances

Contêiner de todas as informações sobre a instância reservada. Para mais informações, consulte Compra de instâncias reservadas (AWS CLI).

DissociatePackage

Remove o pacote do domínio do OpenSearch Service especificado. O pacote não pode ser usado com nenhum índice do OpenSearch para que a dissociação seja bem-sucedida. O pacote ainda está disponível no OpenSearch Service para associação posterior.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/packages/dissociate/package-id/domain-name

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
PackageID String Sim ID interno do pacote que você deseja dissociar do domínio. Use ListPackagesForDomain para localizar esse valor.
DomainName DomainName Sim Nome do domínio do qual você deseja dissociar o pacote.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados
DomainPackageDetails DomainPackageDetails

GetCompatibleVersions

Retorna um mapa de versões do OpenSearch e do Elasticsearch e as versões para as quais você pode atualizar.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/compatibleVersions?domainName=domain-name

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
DomainName DomainName Não O nome de um domínio existente.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
CompatibleVersions Mapa Um mapa de versões do OpenSearch e do Elasticsearch e as versões para as quais você pode atualizar:
{ "CompatibleVersions": [{ "SourceVersion": "Elasticsearch_7.10", "TargetVersions": ["OpenSearch_1.0"] }] }

GetPackageVersionHistory

Retorna um mapa de versões do OpenSearch e as versões para as quais você pode atualizar.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/packages/package-id/history?maxResults=max-results&nextToken=next-token

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
PackageID String Sim O nome de um domínio existente.
MaxResults Inteiro Não Limita o número de resultados. Deve estar entre 30 e 100.
NextToken String Não Usado para paginação. Necessário apenas se uma chamada de API anterior tiver produzido um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
PackageVersionHistoryList Mapa Uma lista de mensagens de confirmação, tempos de atualização e versões para o pacote fornecido:
"PackageVersionHistoryList": [ { CommitMessage": "Add new synonyms", "CreatedAt": 1.605225005466E9, "PackageVersion": "v4" } ]

GetUpgradeHistory

Retorna uma lista das 10 operações de atualização mais recentes do domínio.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/upgradeDomain/domain-name/history?maxResults=max-results&nextToken=next-token

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
MaxResults Inteiro Não Limita o número de resultados. Deve estar entre 30 e 100.
DomainName DomainName Sim O nome de um domínio existente.
NextToken String Não Usado para paginação. Necessário apenas se uma chamada de API anterior tiver produzido um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
UpgradeHistoryList UpgradeHistoryList Contêiner para logs de resultados das últimas 10 operações de atualização.

GetUpgradeStatus

Retorna o status mais recente de uma atualização de versão de um domínio do OpenSearch ou Elasticsearch.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/upgradeDomain/domain-name/status

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
DomainName DomainName Sim O nome de um domínio existente.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
UpgradeStepItem UpgradeStepItem Contêiner para o status mais recente de uma atualização de versão de um domínio.

ListDomainNames

Exibe o nome de todos os domínios do OpenSearch Service pertencentes ao usuário atual na região ativa.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/domain

Parâmetros de solicitação

Campo Tipo de dados Obrigatório? Descrição
EngineType String Não Filtra a saída por tipo de mecanismo de domínio. Os valores aceitáveis são Elasticsearch e OpenSearch.

Essa operação não usa parâmetros de solicitação.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
DomainNameList DomainNameList Nome de todos os domínios do OpenSearch Service pertencentes ao usuário atual.

ListDomainsForPackage

Lista todos os domínios do OpenSearch Service aos quais um pacote está associado.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/packages/package-id/domains?maxResults=max-results&nextToken=next-token

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
PackageID String Sim O pacote para o qual listar domínios.
MaxResults Inteiro Não Limita o número de resultados.
NextToken String Não Usado para paginação. Necessário apenas se uma chamada de API anterior produziu um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
DomainPackageDetailsList List Lista de objetos DomainPackageDetails.
NextToken String Usado para paginação. Necessário apenas se uma chamada de API anterior tiver produzido um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

ListVersions

Lista todas as versões compatíveis do OpenSearch e do Elasticsearch no OpenSearch Service.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/versions?maxResults=max-results&nextToken=next-token

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
MaxResults Inteiro Não Limita o número de resultados. Deve estar entre 30 e 100.
NextToken String Não Usado para paginação. Necessário apenas se uma chamada de API anterior tiver produzido um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

ListInstanceTypeDetails

Lista todos os tipos de instância e recursos disponíveis para uma determinada versão do OpenSearch ou do Elasticsearche.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/instanceTypeDetails/engine-version?domainName=domain-name?maxResults=max-results&nextToken=next-token

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
EngineVersion String Sim Versão do OpenSearch ou Elasticsearch, no formato Elasticsearch_X.Y ou OpenSearch_x.y. O padrão é a versão mais recente do OpenSearch. Para obter a lista completa de versões compatíveis, consulte Versões compatíveis do OpenSearch e do Elasticsearch..
DomainName DomainName Sim Nome do domínio do qual você deseja listar detalhes do tipo de instância.

MaxResults

Inteiro

Não

Limita o número de resultados. Deve estar entre 30 e 100.
NextToken String Não Usado para paginação. Necessário apenas se uma chamada de API anterior tiver produzido um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
InstanceTypeDetails List Lista todos os tipos de instância e recursos compatívies com determinada versão do OpenSearch ou do Elasticsearche.
NextToken String Usado para paginação. Necessário apenas se uma chamada de API anterior tiver produzido um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

ListPackagesForDomain

Lista todos os pacotes associados ao domínio do OpenSearch Service.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/domain/domain-name/packages?maxResults=max-results&nextToken=next-token

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
DomainName String Sim O nome do domínio para o qual você deseja listar pacotes associados.
MaxResults Inteiro Não Limita o número de resultados.
NextToken String Não Usado para paginação. Necessário apenas se uma chamada de API anterior produziu um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
DomainPackageDetailsList List Lista de objetos DomainPackageDetails.
NextToken String Usado para paginação. Necessário apenas se uma chamada de API anterior tiver produzido um resultado que contém NextToken. Aceita uma entrada de próximo token para retornar resultados para a próxima página e fornece uma saída de próximo token na resposta, que os clientes podem usar para recuperar mais resultados.

ListTags

Exibe todas as tags de recurso para um domínio do OpenSearch Service.

Sintaxe

GET https://es.us-east-1.amazonaws.com/2021-01-01/tags?arn=domain-arn

Parâmetros de solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
ARN ARN Sim Nome do recurso da Amazon (ARN) para o domínio do OpenSearch Service.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
TagList TagList Lista de tags de recurso. Para mais informações, consulte Marcação de domínios do Amazon OpenSearch Service.

PurchaseReservedInstanceOffering

Compra uma instância reservada.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/purchaseReservedInstanceOffering { "ReservationName" : "my-reservation", "ReservedInstanceOfferingId" : "1a2a3a4a5-1a2a-3a4a-5a6a-1a2a3a4a5a6a", "InstanceCount" : 3 }

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação HTTP.

Corpo da solicitação

Name (Nome) Tipo de dados Obrigatório? Descrição
ReservationName String Sim Um nome descritivo para a reserva. Deve conter entre 5 e 64 caracteres.
ReservedInstanceOfferingId String Sim O ID da oferta.
InstanceCount Inteiro Sim O número de instâncias que você deseja reservar.

Elementos de resposta

Campo Tipo de dados Descrição
ReservationName String O nome da reserva.
ReservedInstanceId String O ID da reserva.

RejectInboundConnection

Permite que o proprietário do domínio de destino rejeite uma solicitação de conexão de pesquisa entre clusters de entrada.

Sintaxe

PUT https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/inboundConnection/connection-id/reject

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação HTTP.

Corpo da solicitação

Essa operação não usa o corpo de solicitação HTTP.

Elementos de resposta

Campo Tipo de dados Descrição
CrossClusterSearchConnection Objeto Detalhes da conexão de entrada.

RemoveTags

Remove as tags de recurso especificadas de um domínio do OpenSearch Service.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/tags-removal { "ARN": "arn:aws:es:us-east-1:123456789012:domain/my-domain", "TagKeys": [ "tag-key1", "tag-key2" ] }

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação HTTP.

Corpo da solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
ARN ARN Sim Nome do recurso da Amazon (ARN) de um domínio do OpenSearch Service. Para obter mais informações, consulte Identificadores do IAM no Manual do usuário do AWS Identity and Access Management.
TagKeys TagKey Sim Lista de chaves de tag para tags de recurso que você deseja remover de um domínio do OpenSearch Service.

Elementos de resposta

A operação RemoveTags não retorna um elemento de resposta.

StartServiceSoftwareUpdate

Agenda uma atualização do software de serviço para um domínio do OpenSearch Service.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/serviceSoftwareUpdate/start { "DomainName": "domain-name" }

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação HTTP.

Corpo da solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
DomainName DomainName Sim Nome do domínio OpenSearch Service que você deseja atualizar para o software de serviço mais recente.

Elementos de resposta

Campo Tipo de dados Descrição
ServiceSoftwareOptions ServiceSoftwareOptions Contêiner para o estado do seu domínio em relação ao software de serviço mais recente.

CancelServiceSoftwareUpdate

Agenda uma atualização do software de serviço agendada para um domínio do OpenSearch Service. Somente funciona se o domínio UpdateStatus é PENDING_UPDATE.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/serviceSoftwareUpdate/stop { "DomainName": "domain-name" }

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação HTTP.

Corpo da solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
DomainName DomainName Sim Nome do domínio OpenSearch Service que você deseja atualizar para o software de serviço mais recente.

Elementos de resposta

Campo Tipo de dados Descrição
ServiceSoftwareOptions ServiceSoftwareOptions Contêiner para o estado do seu domínio em relação ao software de serviço mais recente.

UpdateDomainConfig

Modifica a configuração de um domínio do OpenSearch Service, como o tipo de instância e o número de instâncias. Basta especificar os valores que você deseja atualizar.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name/config { "ClusterConfig": { "ZoneAwarenessConfig": { "AvailabilityZoneCount": 3 }, "ZoneAwarenessEnabled": true|false, "InstanceCount": 3, "DedicatedMasterEnabled": true|false, "DedicatedMasterType": "c5.large.search", "DedicatedMasterCount": 3, "InstanceType": "r5.large.search", "WarmCount": 6, "WarmType": "ultrawarm1.medium.search", "ColdStorageOptions": { "Enabled": true|false }, "EBSOptions": { "EBSEnabled": true|false, "VolumeType": "gp3|gp2|io1|standard", "VolumeSize": 35, "Iops": 3000, "Throughput": 125 }, "SnapshotOptions": { "AutomatedSnapshotStartHour": 3 }, "EncryptionAtRestOptions": { "Enabled": true|false, "KmsKeyId":"arn:aws:kms:us-east-1:123456789012:alias/my-key" }, "NodeToNodeEncryptionOptions": { "Enabled": true|false }, "VPCOptions": { "SubnetIds": ["subnet-abcdefg1", "subnet-abcdefg2", "subnet-abcdefg3"], "SecurityGroupIds": ["sg-12345678"] }, "AdvancedOptions": { "rest.action.multi.allow_explicit_index": "true|false", "indices.fielddata.cache.size": "40", "indices.query.bool.max_clause_count": "1024", "override_main_response_version": "true|false" }, "CognitoOptions": { "Enabled": true|false, "UserPoolId": "us-east-1_121234567", "IdentityPoolId": "us-east-1:12345678-1234-1234-1234-123456789012", "RoleArn": "arn:aws:iam::123456789012:role/service-role/CognitoAccessForAmazonOpenSearch" }, "DomainEndpointOptions": { "EnforceHTTPS": true|false, "TLSSecurityPolicy": "Policy-Min-TLS-1-2-2019-07|Policy-Min-TLS-1-0-2019-07", "CustomEndpointEnabled": "true|false", "CustomEndpoint": "www.my-custom-endpoint.com", "CustomEndpointCertificateArn": "arn:aws:iam::123456789012:certificate/my-certificate" }, "LogPublishingOptions": { "SEARCH_SLOW_LOGS": { "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group1:sample-domain", "Enabled":true|false }, "INDEX_SLOW_LOGS": { "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group2:sample-domain", "Enabled":true|false }, "ES_APPLICATION_LOGS": { "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group3:sample-domain", "Enabled":true|false } }, "AdvancedSecurityOptions": { "Enabled": true|false, "InternalUserDatabaseEnabled": true|false, "AnonymousAuthEnabled": true|false, "AnonymousAuthDisableDate": 1234567890, "MasterUserOptions": { "MasterUserARN": "arn:aws:iam::123456789012:role/my-master-user-role" "MasterUserName": "my-master-username", "MasterUserPassword": "my-master-password" }, "SAMLOptions": { "Enabled": true, "Idp": { "EntityId": "entity-id", "MetadataContent": "metadata-content-with-quotes-escaped" }, "RolesKey": "optional-roles-key", "SessionTimeoutMinutes": 180, "SubjectKey": "optional-subject-key" } }, "AutoTuneOptions": { "DesiredState": "ENABLED|DISABLED", "MaintenanceSchedules": [{ "StartAt": 1234567890, "Duration": { "Value": 2, "Unit": "HOURS" }, "CronExpressionForRecurrence": "cron(0 0 ? * 3 *)" }], "RollbackOnDisable": "NO_ROLLBACK|DEFAULT_ROLLBACK" }, "DomainName": "my-domain", "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"*\"]},\"Action\":[\"es:*\"],\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/my-domain/*\"}]}", "DryRun": true|false }

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação HTTP.

Corpo da solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
DomainName DomainName Sim Nome do domínio do OpenSearch Service para a qual você deseja atualizar a configuração.
ClusterConfig ClusterConfig Não Alterações desejadas para a configuração do cluster, como o tipo de instância e o número de instâncias do EC2.
EBSOptions EBSOptions Não Tipo e tamanho dos volumes do EBS anexados aos nós de dados.
VPCOptions VPCOptions Não Contêiner dos valores necessários para configurar o OpenSearch Service para funcionar com uma VPC. Para saber mais, consulte Como iniciar seus domínios do Amazon OpenSearch Service em uma VPC.
SnapshotOptions SnapshotOptions Não SUSPENSO. Hora em que o serviço obtém um snapshot automatizado diário dos índices no domínio do OpenSearch Service.
AdvancedOptions AdvancedOptions Não Pares de chave/valor para especificar opções de configuração avançada. Para mais informações, consulte Configurações avançadas do cluster.
AccessPolicies String Não Especifica as políticas de acesso para o domínio do OpenSearch Service. Para mais informações, consulte Configuração de políticas de acesso.
LogPublishingOptions LogPublishingOptions Não String de pares de chave-valor para configurar a publicação de logs lentos.
CognitoOptions CognitoOptions Não Pares de chave/valor para configurar o OpenSearch Service para usar a autenticação do Amazon Cognito para o OpenSearch Dashboards.
DomainEndpointOptions DomainEndpointOptions Não Opções adicionais para o endpoint do domínio, como exigir HTTPS para todo o tráfego.
AdvancedSecurityOptions AdvancedSecurityOptions Não Opções para controle de acesso refinado.
AutoTuneOptions AutoTuneOptions Não Opções para Auto-Tune.
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions Não Habilita a criptografia de nó a nó.
EncryptionAtRestOptions EncryptionAtRestOptions Não Pares de chave-valor para ativar a criptografia em repouso.
DryRun Booliano Não Padronizado como false. Se for true, o OpenSearch Service verifica se a alteração de configuração causará uma implantação azul/verde, mas não executa a atualização.

Elementos de resposta

Campo Tipo de dados
DomainConfig DomainConfig
DryRunResults DryRunResults

UpdatePackage

Atualize um pacote para uso com domínios do OpenSearch Service.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/packages/update { "PackageID": "F11111111", "PackageDescription": "My synonym file.", "CommitMessage": "Added some synonyms.", "PackageSource": { "S3BucketName": "my-s3-bucket", "S3Key": "synonyms.txt" } }

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação.

Corpo da solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
PackageID String Sim ID exclusivo do pacote.
PackageDescription String Não Descrição do pacote.
CommitMessage String Não Mensagem de confirmação para o arquivo atualizado.
PackageSource PackageSource Sim Bucket do S3 e chave do pacote.

Elementos de resposta

Campo Tipo de dados
PackageDetails PackageDetails

UpgradeDomain

Atualiza um domínio do OpenSearch Service para uma nova versão do OpenSearch ou Elasticsearch. Como alternativa, verifica a qualificação da atualização.

Sintaxe

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/upgradeDomain { "DomainName": "domain-name", "TargetVersion": "OpenSearch_1.0", "PerformCheckOnly": true|false }

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação HTTP.

Corpo da solicitação

Parâmetro Tipo de dados Obrigatório? Descrição
DomainName String Sim Nome do domínio do OpenSearch Service que você deseja atualizar.
TargetVersion String Sim Versão do OpenSearch ou Elasticsearch para a qual você deseja atualizar, no formato Opensearch_X.Y ou Elasticsearch_X.Y. Consulte GetCompatibleVersions.
PerformCheckOnly Booliano Não Padronizado como false. Se true, o OpenSearch Service verificará a elegibilidade do domínio, mas não executará a atualização.

AdvancedOptions

AdvancedOptions Não Oferece suporte somente ao parâmetro override_main_response_version, e não outras opções avançadas. Você só pode incluir essa opção durante a atualização para uma versão do OpenSearch. Especifica se o domínio informa sua versão como 7.10 para que ele continue funcionando com clientes e plugins do Elasticsearch OSS.

Elementos de resposta

Campo Tipo de dados Descrição
UpgradeDomainResponse Mapa Resposta básica confirmando detalhes da operação.

Tipos de dados

Esta seção descreve os tipos de dados usados pela API de configuração.

AdvancedOptions

Pares de chave/valor para especificar opções de configuração avançadas do OpenSearch.

Campo Tipo de dados Descrição
rest.action.multi.allow_explicit_index Par de chave/valor:

"rest.action.multi.allow_explicit_index":"true"

Observe o uso de uma string em vez de um booliano. Especifica se são permitidas referências explícitas aos índices dentro do corpo das solicitações HTTP. Se você desejar configurar políticas de acesso para sub-recursos do domínio, como índices e APIs específicos ao domínio, será necessário desativar essa propriedade. Para obter mais informações sobre políticas de acesso para sub-recursos, consulte Configuração de políticas de acesso.
indices.fielddata.cache.size Par de chave/valor:

"indices.fielddata.cache.size":"80"

Observe o uso de uma string em vez de um número inteiro. Especifica a porcentagem de espaço do heap do Java alocada a dados de campo. Por padrão, essa configuração é ilimitada.
indices.query.bool.max_clause_count Par de chave/valor:

"indices.query.bool.max_clause_count":"1024"

Observe o uso de uma string em vez de um número inteiro. Especifica o número máximo de cláusulas permitidas em uma consulta booliana no Lucene. O padrão é 1.024. Consultas com um número de cláusulas maior que o permitido que resultam em um erro TooManyClauses. Para saber mais, consulte a documentação do Lucene.
override_main_response_version Par de chave/valor:

"override_main_response_version":"true"

Observe o uso de uma string em vez de um booliano. Especifica se o domínio informa sua versão como 7.10 para permitir que clientes e plugins do Elasticsearch OSS continuem funcionando com ele. Relevante apenas na criação de um domínio do OpenSearch ou atualização para o OpenSearch a partir de uma versão do Elasticsearch OSS. O padrão é false ao criar um domínio e true ao atualizar um domínio.

AdvancedSecurityOptions

Campo Tipo de dados Descrição
Enabled Booliano Verdadeiro para habilitar o controle de acesso refinado.
AnonymousAuthEnabled Booliano Verdadeiro para habilitar um período de migração de 30 dias durante o qual os administradores poderão criar mapeamentos de função. Só é necessário habilitar o controle de acesso refinado em domínios existentes.
AnonymousAuthDisableDate Timestamp Data e hora em que o período de migração será encerrado.
InternalUserDatabaseEnabled Booliano Verdadeiro para habilitar o banco de dados interno de usuários.
MasterUserOptions MasterUserOptions Contêiner para informações sobre o usuário primário.
SAMLOptions SAMLOptions Contêiner para informações sobre a configuração do SAML para o OpenSearch Dashboards.

ARN

Campo Tipo de dados Descrição
ARN String Nome do recurso da Amazon (ARN) de um domínio do OpenSearch Service. Para obter mais informações, consulte ARNs do IAM no Manual do usuário do AWS Identity and Access Management.

AutoTuneOptions

Campo Tipo de dados Descrição
DesiredState String ENABLED ou DISABLED.
MaintenanceSchedules List

Uma lista de programações de manutenção durante as quais o Auto-Tune pode implantar alterações:

{ "StartAt": 1234567890, "Duration": { "Value": 2, "Unit": "HOURS" }, "CronExpressionForRecurrence": "cron(* * ? * * *)" }

Os agendamentos de manutenção são sobrescrever, e não acrescentar. Se sua solicitação não incluir agendamentos, a solicitação excluirá todos os agendamentos existentes. Para preservar as agendas existentes, faça uma chamada para DescribeDomainConfig primeiro e use a parte MaintenanceSchedules da resposta como base para esta seção.

StartAt é uma época, e Value é um inteiro longo.

RollbackOnDisable String Ao desabilitar o Auto-Tune, especifique NO_ROLLBACK para manter todas as configurações anteriores do Auto-Tune ou DEFAULT_ROLLBACK para reverter para os padrões do OpenSearch Service.

Se você especificar DEFAULT_ROLLBACK, deverá incluir um MaintenanceSchedule na solicitação. Caso contrário, o OpenSearch Service não poderá executar a reversão.

ChangeProgressDetails

Contêiner para informações sobre uma alteração de configuração sendo feita em um domínio.

Campo Tipo de dados Descrição
ChangeId String O ID da alteração de configuração.
Message String Uma mensagem correspondente ao status da alteração de configuração.

ChangeProgressStatus

Contêiner para informações sobre as etapas de uma alteração de configuração sendo feita em um domínio.

Campo Tipo de dados Descrição
ChangeId String ID da alteração de configuração.
ChangeProgressStages Objeto Detalhes do progresso de cada etapa do processo de atualização. Cada etapa apresenta os campos Description, LastUpdated, Name e Status.
CompletedProperties StringList Lista das propriedades de domínios que já foram atualizadas.
PendingProperties StringList Lista das propriedades de domínios que ainda precisam ser atualizadas.
StartTime Timestamp Data e hora em que a alteração de configuração foi iniciada.
Status String Status atual da alteração de configuração.
TotalNumberOfStages Inteiro Número total de etapas necessárias para que a alteração da configuração seja concluída.

ClusterConfig

Contêiner para a configuração de cluster de um domínio do OpenSearch Service.

Campo Tipo de dados Descrição
InstanceType String Tipo de Instância de nós de dados no cluster.
InstanceCount Inteiro Número de instâncias no cluster.
DedicatedMasterEnabled Booliano Indica se os nós principais dedicados estão habilitados para o cluster. True se o cluster for usar um nó principal dedicado. False se o cluster não for. Para mais informações, consulte Nós principais dedicados no Amazon OpenSearch Service.
DedicatedMasterType String Tipo de instância do OpenSearch Service de nós principais dedicados no cluster.
DedicatedMasterCount Inteiro Número de nós principais dedicados no cluster. Esse número deve ser maior do que 1, caso contrário, você receberá uma exceção de validação.
ZoneAwarenessEnabled Booliano Indica se várias zonas de disponibilidade estão habilitadas. Para mais informações, consulte Configuração de um domínio Multi-AZ no Amazon OpenSearch Service.
ZoneAwarenessConfig ZoneAwarenessConfig Contêiner para opções de configuração de reconhecimento da zona. Necessário somente se ZoneAwarenessEnabled for true.
WarmEnabled Booliano Determina se o armazenamento de alta atividade deve ser ativado para o cluster.
WarmCount Inteiro O número de nós de alta atividade no cluster.
WarmType String O tipo de instância para os nós de alta atividade do cluster.
WarmStorage Inteiro A quantidade total provisionada de armazenamento de alta atividade em GiB.
ColdStorageOptions ColdStorageOptions Contêiner para opções de configuração de armazenamento de baixa atividade.

CognitoOptions

Campo Tipo de dados Descrição
Enabled Booliano Opção de habilitar ou desabilitar a autenticação do Amazon Cognito para OpenSearch Dashboards. Consulte Configuração da autenticação do Amazon Cognito para OpenSearch Dashboards.
UserPoolId String O ID do grupo de usuários do Amazon Cognito que você deseja que o OpenSearch Service use para autenticação do OpenSearch Dashboards.
IdentityPoolId String O ID do grupo de identidades do Amazon Cognito que você deseja que o OpenSearch Service use para autenticação do OpenSearch Dashboards.
RoleArn String A função AmazonOpenSearchServiceCognitoAccess que permite que o OpenSearch Service configure seus grupos de usuários e de identidades.

ColdStorageOptions

Contêiner para os parâmetros necessários para habilitar o armazenamento de baixa atividade para um domínio do OpenSearch Service.

Campo Tipo de dados Descrição
Enabled Booliano Opção de habilitar ou desabilitar o armazenamento de baixa atividade no domínio. Consulte Armazenamento de baixa atividade para Amazon OpenSearch Service.

CreateDomainRequest

Contêiner de parâmetros necessários para a operação de serviço CreateDomain.

Campo Tipo de dados Descrição
DomainName DomainName Nome do domínio do OpenSearch Service a ser criado.
ClusterConfig ClusterConfig Contêiner para a configuração de cluster de um domínio do OpenSearch Service.
EBSOptions EBSOptions Contêiner para os parâmetros necessários para habilitar o armazenamento baseado em EBS para um domínio do OpenSearch Service.
AccessPolicies String Documento de política do IAM que especifica políticas de acesso para o novo domínio do OpenSearch Service. Para mais informações, consulte Configuração de políticas de acesso.
DomainEndpointOptions DomainEndpointOptions Opções adicionais para o endpoint do domínio, como exigir HTTPS para todo o tráfego.
SnapshotOptions SnapshotOptions SUSPENSO. Contêiner para os parâmetros necessários para configurar snapshots automatizados de índices de domínio.
VPCOptions VPCOptions Contêiner dos valores necessários para configurar o OpenSearch Service para funcionar com uma VPC.
LogPublishingOptions LogPublishingOptions String de pares de chave-valor para configurar a publicação de logs lentos.
AdvancedOptions AdvancedOptions Pares de chave/valor para especificar opções de configuração avançada.
CognitoOptions CognitoOptions Pares de chave/valor para configurar o OpenSearch Service para usar a autenticação do Amazon Cognito para o OpenSearch Dashboards.
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions Especifique true para ativar a criptografia de nó a nó.

DomainEndpointOptions

Campo Tipo de dados Descrição
EnforceHTTPS Booliano true para exigir que todo o tráfego para o domínio seja entregue por HTTPS.
TLSSecurityPolicy String A versão mínima do TLS necessária para o tráfego para o domínio. Os valores válidos são TLS 1.0 (padrão) ou 1.2:
  • Policy-Min-TLS-1-0-2019-07

  • Policy-Min-TLS-1-2-2019-07

CustomEndpointEnabled Booliano Opção para habilitar um endpoint personalizado para o domínio.
CustomEndpoint String O URL totalmente qualificado do endpoint personalizado.
CustomEndpointCertificateArn String O ARN do seu certificado de segurança, gerenciado no ACM.

DomainID

Tipo de dados Descrição
String Identificador exclusivo para um domínio do OpenSearch Service.

DomainName

Nome de um domínio do OpenSearch Service.

Tipo de dados Descrição
String Nome de um domínio do OpenSearch Service. Os nomes de domínio são exclusivos em todos os domínios pertencentes à mesma conta dentro de uma Região da AWS. Os nomes de domínio devem começar com letra minúscula e devem ter entre 3 e 28 caracteres. Os caracteres válidos são a-z (minúsculas apenas), 0-9 e – (hífen).

DomainNameList

String nomes de domínios do OpenSearch Service.

Tipo de dados Descrição
String Array Matriz de domínios do OpenSearch Service no formato a seguir:

["<Domain_Name>","<Domain_Name>"...]

DomainPackageDetails

Informações sobre um pacote associado a um domínio.

Campo Tipo de dados Descrição
DomainName String Nome do domínio ao qual você associou um pacote.
DomainPackageStatus String Estado da associação. Os valores são ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING e DISSOCIATION_FAILED.
ErrorDetails String Informações adicionais se o pacote estiver em um estado de erro. Caso contrário, nulo.
LastUpdated Timestamp Timestamp da atualização mais recente para o status da associação.
PackageID String ID interno do pacote.
PackageName String Nome do pacote especificado pelo usuário.
PackageType String No momento, oferece suporte apenas a TXT-DICTIONARY.
ReferencePath String Indica a localização do pacote em nós de cluster do OpenSearch Service. É o mesmo que synonym_path para arquivos de dicionário.

DomainConfig

Contêiner para a configuração de um domínio do OpenSearch Service.

Campo Tipo de dados Descrição
EngineVersion String Versão do OpenSearch ou Elasticsearch.
ClusterConfig ClusterConfig Contêiner para a configuração de cluster de um domínio do OpenSearch Service.
EBSOptions EBSOptions Contêiner para opções do EBS configuradas para um domínio do OpenSearch Service.
AccessPolicies String Especifica as políticas de acesso para o domínio do OpenSearch Service. Para mais informações, consulte Configuração de políticas de acesso.
SnapshotOptions SnapshotOptions SUSPENSO. Contêiner para os parâmetros necessários para configurar snapshots automatizados de índices de domínio.
DomainEndpointOptions DomainEndpointOptions Opções adicionais para o endpoint do domínio, como exigir HTTPS para todo o tráfego.
VPCOptions VPCDerivedInfo As VPCOptions atuais para o domínio e o status de qualquer atualização da configuração.
LogPublishingOptions LogPublishingOptions de pares de chave-valor para configurar a publicação de logs lentos.
AdvancedOptions AdvancedOptions Pares de chave/valor para especificar opções de configuração avançada.
EncryptionAtRestOptions EncryptionAtRestOptions Pares de chave-valor para ativar a criptografia em repouso.
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions Se a criptografia de nó a nó estiver ativada ou desativada.
ChangeProgressDetails ChangeProgressDetails Contêiner para informações sobre o progresso da alteração de configuração.

DomainStatus

Contêiner para conteúdo de uma estrutura de dados DomainStatus.

Campo Tipo de dados Descrição
DomainID DomainID Identificador exclusivo para um domínio do OpenSearch Service.
DomainName DomainName Nome de um domínio do OpenSearch Service. Os nomes de domínio são exclusivos em todos os domínios pertencentes à mesma conta dentro de uma Região da AWS. Os nomes de domínio devem começar com letra minúscula e devem ter entre 3 e 28 caracteres. Os caracteres válidos são a-z (minúsculas apenas), 0-9 e – (hífen).
ARN ARN Nome do recurso da Amazon (ARN) de um domínio do OpenSearch Service. Para obter mais informações, consulte Identificadores do IAM no Manual do usuário do AWS Identity and Access Management.
Created Booliano Status de criação de um domínio do OpenSearch Service. True se a criação do domínio estiver concluída. False se a criação do domínio ainda estiver em andamento.
Deleted Booliano Status de exclusão de um domínio do OpenSearch Service. True se a exclusão do domínio estiver concluída. False se a exclusão do domínio ainda estiver em andamento.
Endpoint ServiceUrl Endpoint específico do domínio usado para enviar solicitações de índice, pesquisa e upload de dados a um domínio do OpenSearch Service.
Endpoints EndpointsMap O par chave-valor existente quando o domínio do OpenSearch Service usa endpoints da VPC.
Processing Booliano Status de uma alteração na configuração de um domínio do OpenSearch Service. True se o serviço ainda estiver processando as alterações de configuração. False se a alteração de configuração estiver ativa. Você deve esperar o domínio atingir o status ativo para enviar solicitações de índice, pesquisa e upload de dados.
EngineVersion String Versão do OpenSearch ou Elasticsearch.
ClusterConfig ClusterConfig Contêiner para a configuração de cluster de um domínio do OpenSearch Service.
EBSOptions EBSOptions Contêiner para os parâmetros necessários para habilitar o armazenamento baseado em EBS para um domínio do OpenSearch Service.
AccessPolicies String Documento de política do IAM que especifica políticas de acesso para o novo domínio do OpenSearch Service. Para mais informações, consulte Configuração de políticas de acesso.
SnapshotOptions SnapshotOptions SUSPENSO. Contêiner para os parâmetros necessários para configurar o horário dos snapshots automatizados diários dos índices do domínio do OpenSearch Service.
VPCOptions VPCDerivedInfo Informações derivadas pelo OpenSearch Service com base em VPCOptions do domínio.
LogPublishingOptions LogPublishingOptions de pares de chave-valor para configurar a publicação de logs lentos.
AdvancedOptions AdvancedOptions Pares de chave/valor para especificar opções de configuração avançada.
EncryptionAtRestOptions EncryptionAtRestOptions Pares de chave-valor para ativar a criptografia em repouso.
CognitoOptions CognitoOptions Pares de chave/valor para configurar o OpenSearch Service para usar a autenticação do Amazon Cognito para o OpenSearch Dashboards.
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions Se a criptografia de nó a nó estiver ativada ou desativada.
UpgradeProcessing Booliano True (Verdadeiro) se uma atualização para uma nova versão do OpenSearch ou Elasticsearch estiver em andamento.
ServiceSoftwareOptions ServiceSoftwareOptions O status do software de serviço do domínio.

DomainStatusList

Lista que contém o status de cada domínio especificado do OpenSearch Service.

Campo Tipo de dados Descrição
DomainStatusList DomainStatus Lista que contém o status de cada domínio especificado do OpenSearch Service.

DryRunResults

Resultados de uma simulação executada em uma solicitação de domínio de atualização.

Campo Tipo de dados Descrição
DeploymentType String Os resultados de uma simulação executada em uma operação UpdateDomainConfig. Descreve o tipo de implantação que a atualização causará. Um dos quatro valores:
  • Azul/verde

  • DynamicUpdate

  • Indeterminado

  • Nenhum

Message String

Uma mensagem correspondente ao tipo de implantação.

EBSOptions

Contêiner para os parâmetros necessários para habilitar o armazenamento baseado em EBS para um domínio do OpenSearch Service.

Campo Tipo de dados Descrição
EBSEnabled Booliano Indica se os volumes do EBS estão anexados a nós de dados em um domínio do OpenSearch Service.
VolumeType String Especifica o tipo de volume do EBS anexado a nós de dados. As opções são gp3, gp2, io1 e standard (magnético).
VolumeSize String Especifica o tamanho (em GiB) do volume do EBS anexado a nós de dados.
Iops String Especifica a performance de referência de entrada/saída (E/S)dos volumes do EBS anexados aos nós de dados. Aplicável apenas para os tipos de volume gp3 e EBS com IOPS provisionadas.
Throughput String Especifica o throughput (em MiB/s) dos volumes do EBS anexados aos nós de dados. Aplicável apenas para o tipo de volume gp3.

EncryptionAtRestOptions

Especifica se o domínio deve criptografar dados em repouso e, se esse for o caso, qual chave do AWS Key Management Service (KMS) usar. Só pode ser usado para criar um domínio, não para atualizar um existente. Para saber mais, consulte Ativação da criptografia de dados em repouso.

Campo Tipo de dados Descrição
Enabled Booliano Especifique true para ativar a criptografia em repouso.
KmsKeyId String O ID da chave do KMS. Assume o formato 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

EndpointsMap

O par chave-valor que contém o VPC endpoint. Só existe se o domínio do OpenSearch Service reside em uma VPC.

Campo Tipo de dados Descrição
Endpoints Par de string de chave/valor: "vpc": "<VPC_ENDPOINT>" O VPC endpoint do domínio.

Filtros

Filtra os pacotes incluídos em uma resposta DescribePackages.

Campo Tipo de dados Descrição
Name String Qualquer campo do PackageDetails.
Value List Uma lista de valores do campo especificado.

Opções de publicação de logs

Especifica se o domínio do OpenSearch Service publica a aplicação OpenSearch e os logs lentos no Amazon CloudWatch. Você ainda tem que habilitar a coleta de logs lentos usando a API REST do OpenSearch. Para saber mais, consulte Configuração dos limites de logs do OpenSearch para logs lentos.

Campo Tipo de dados Descrição
INDEX_SLOW_LOGS Chave-valor

Dois pares de chave-valor que definem o grupo de logs do CloudWatch e se o log lento de índice do OpenSearch deve ser publicado lá:

"CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group:sample-domain", "Enabled":true
SEARCH_SLOW_LOGS Chave-valor

Dois pares de chave-valor que definem o grupo de logs do CloudWatch e se o log lento de pesquisa do OpenSearch deve ser publicado lá:

"CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group:sample-domain", "Enabled":true
ES_APPLICATION_LOGS Chave-valor Dois pares de chave-valor que definem o grupo de logs do CloudWatch e se os logs de erro do OpenSearch devem ser publicados lá:
"CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group:sample-domain", "Enabled":true

MasterUserOptions

Campo Tipo de dados Descrição
MasterUserARN String ARN para o usuário primário. Especifique somente se InternalUserDatabaseEnabled estiver false em AdvancedSecurityOptions.
MasterUserName String O nome de usuário para o usuário primário. Especifique somente se InternalUserDatabaseEnabled estiver true em AdvancedSecurityOptions.
MasterUserPassword String A senha para o usuário primário. Especifique somente se InternalUserDatabaseEnabled estiver true em AdvancedSecurityOptions.

NodeToNodeEncryptionOptions

Habilita ou desabilita a criptografia de nó a nó.

Campo Tipo de dados Descrição
Enabled Booliano Habilitar com true

OptionState

Estado de uma atualização nas opções avançadas de um domínio do OpenSearch Service.

Campo Tipo de dados Descrição
OptionStatus String Um de três valores válidos:
  • RequiresIndexDocuments

  • Processamento

  • Ativo

OptionStatus

Status de uma atualização nas opções de configuração de um domínio do OpenSearch Service.

Campo Tipo de dados Descrição
CreationDate Timestamp Data e hora em que o domínio do OpenSearch Service foi criado.
UpdateDate Timestamp Data e hora em que o domínio do OpenSearch Service foi atualizado.
UpdateVersion Inteiro Número inteiro que especifica a versão mais recente da entidade.
State OptionState Estado de uma atualização nas opções de configuração de um domínio do OpenSearch Service.
PendingDeletion Booliano Indica se o serviço está processando uma solicitação para excluir permanentemente o domínio do OpenSearch Service e todos os seus recursos.

PackageDetails

Informações básicas sobre um pacote.

Campo Tipo de dados Descrição
CreatedAt Timestamp A hora em que o pacote foi criado.
ErrorDetails String Informações adicionais se o pacote estiver em um estado de erro. Caso contrário, nulo.
PackageDescription String Descrição do pacote especificada pelo usuário.
PackageID String ID interno do pacote.
PackageName String Nome do pacote especificado pelo usuário.
PackageStatus String Os valores são COPYING, COPY_FAILED, AVAILABLE, DELETING ou DELETE_FAILED.
PackageType String No momento, oferece suporte apenas a TXT-DICTIONARY.

PackageSource

Bucket e chave do pacote ao qual você deseja adicionar o OpenSearch Service.

Campo Tipo de dados Descrição
S3BucketName String Nome do bucket que contém o pacote.
S3Key String Chave (nome do arquivo) do pacote.

SAMLOptions

Campo Tipo de dados Descrição
Enabled Booliano Opção para habilitar autenticação SAML para o OpenSearch Dashboards.
MasterUserName String Este nome de usuário do IdP do SAML recebe permissões completas para o cluster, equivalente a um novo usuário primário.
MasterBackendRole String Esta função de backend do IdP do SAML recebe permissões completas para o cluster, equivalente a um novo usuário primário.
Idp Objeto

Contêiner para informações do seu provedor de identidade. Contém dois elementos:

"Idp": { "EntityId": "entity-id", "MetadataContent": "metadata-content-with-quotes-escaped" }
RolesKey String Elemento da asserção SAML a ser usado para funções de backend. O padrão é roles.
SubjectKey String Elemento da asserção SAML a ser usado para nome de usuário. O padrão é NameID.
SessionTimeoutMinutes Inteiro Duração de uma sessão em minutos depois que um usuário faz login. O padrão é 60. O valor máximo é 1.440 (24 horas).

ServiceSoftwareOptions

Contêiner para o estado do seu domínio em relação ao software de serviço mais recente.

Campo Tipo de dados Descrição
UpdateAvailable Booliano Se uma atualização do software de serviço está disponível ou não para o seu domínio.
Cancellable Booliano Se você tiver solicitado um domínio de atualização, se você pode cancelar ou não a atualização.
AutomatedUpdateDate Timestamp O horário Epoch em que a janela de implantação fecha para as atualizações necessárias. Após esse tempo, o OpenSearch Service agenda a atualização do software automaticamente.
UpdateStatus String O status da atualização. Os valores são ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED e NOT_ELIGIBLE.
Description String Descrição mais detalhada do status.
CurrentVersion String Sua versão de software de serviço atual.
NewVersion String A versão mais recente do software de serviço.
OptionalDeployment Booliano Se a atualização do software de serviço é opcional.

ServiceURL

Endpoint específico do domínio usado para enviar solicitações de índice, pesquisa e upload de dados a um domínio do OpenSearch Service.

Campo Tipo de dados Descrição
ServiceURL String Endpoint específico do domínio usado para enviar solicitações de índice, pesquisa e upload de dados a um domínio do OpenSearch Service.

SnapshotOptions

SUSPENSO. Consulte Criação de snapshots de índices no Amazon OpenSearch Service. Contêiner para os parâmetros necessários para configurar o horário dos snapshots automatizados diários dos índices em um domínio do OpenSearch Service.

Campo Tipo de dados Descrição
AutomatedSnapshotStartHour Inteiro SUSPENSO. Hora em que o serviço obtém um snapshot automatizado diário dos índices no domínio do OpenSearch Service.

Tag

Campo Tipo de dados Descrição
Key TagKey Nome obrigatório da tag. As chaves de tag devem ser exclusivas ao domínio do OpenSearch Service ao qual elas são anexadas. Para mais informações, consulte Marcação de domínios do Amazon OpenSearch Service.
Value TagValue Valor de string opcional da tag. Os valores de tag podem ser null e não precisam ser exclusivos em um conjunto de tags. Por exemplo, você pode ter um par de chave-valor em um conjunto de tags definido como projeto/Trinity e centro-custos/Trinity.

TagKey

Campo Tipo de dados Descrição
Key String Nome da tag. A string pode ter até 128 caracteres.

TagList

Campo Tipo de dados Descrição
Tag Tag Tag de recurso anexada a um domínio do OpenSearch Service.

TagValue

Campo Tipo de dados Descrição
Value String Contém o valor para um TagKey. A string pode ter até 256 caracteres.

VPCDerivedInfo

Campo Tipo de dados Descrição
VPCId String O ID da sua VPC. A Amazon VPC gera esse valor quando você cria uma VPC.
SubnetIds StringList Uma lista de IDs de sub-rede associados aos VPC endpoints do domínio. Para obter mais informações, consulte VPCs e sub-redes no Manual do usuário da Amazon VPC.
AvailabilityZones StringList A lista de zonas de disponibilidade associadas às sub-redes da VPC. Para obter mais informações, consulte Fundamentos de VPC e sub-redes no Manual do usuário da Amazon VPC.
SecurityGroupIds StringList Uma lista de IDs de grupos de segurança associados aos endpoints da VPC do domínio. Para mais informações, consulte Grupos de segurança para a VPC no Guia do usuário da Amazon VPC.

VPCOptions

Campo Tipo de dados Descrição
SubnetIds StringList Uma lista de IDs de sub-rede associados aos VPC endpoints do domínio. Se o domínio usa várias zonas de disponibilidade, será necessário fornecer dois IDs de sub-rede, um para cada zona. Caso contrário, forneça apenas um. Para saber mais, consulte VPCs e sub-redes no Manual do usuário da Amazon VPC.
SecurityGroupIds StringList Uma lista de IDs de grupos de segurança associados aos endpoints da VPC do domínio. Se você não fornecer um ID de grupo de segurança, o OpenSearch Service usará o grupo de segurança padrão da sua VPC. Para saber mais, consulte Grupos de segurança para a VPC no Manual do usuário da Amazon VPC.
VPCId String ID da VPC.

ZoneAwarenessConfig

Campo Tipo de dados Descrição
AvailabilityZoneCount Inteiro Se você ativou várias zonas de disponibilidade, esse campo é o número de zonas que você deseja que o domínio use. Os valores válidos são 2 e 3.

Erros

O OpenSearch Service emite os seguintes erros:

Exceção Descrição
BaseException Lançada para todos os erros de serviço. Contém o código de status HTTP do erro.
ValidationException Lançada quando a solicitação HTTP contém uma entrada inválida ou não contém a entrada necessária. Retorna código de status HTTP 400.
DisabledOperationException Lançada quando o cliente tenta executar uma operação incompatível. Retorna código de status HTTP 409.
InternalException Lançada quando ocorre um erro interno no serviço durante o processamento de uma solicitação. Retorna código de status HTTP 500.
InvalidTypeException Emitido quando há uma tentativa de criar ou acessar um sub-recurso do domínio do OpenSearch Service que é inválido ou incompatível. Retorna código de status HTTP 409.
LimitExceededException Emitido quando há uma tentativa de criar recursos e sub-recursos do domínio do OpenSearch Service além do número e tipo permitidos. Retorna código de status HTTP 409.
ResourceNotFoundException Lançada ao acessar ou excluir um recurso que não existe. Retorna código de status HTTP 400.
ResourceAlreadyExistsException Emitido quando um cliente tenta criar um recurso que já existe em um domínio do OpenSearch Service. Retorna código de status HTTP 400.