As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Amazon Elasticsearch ServiceReferência sobre a API de configuração do
Essa referência descreve as ações, os tipos de dados e os erros na API de configuração do Amazon Elasticsearch Service. A API de configuração é uma API REST que pode ser usada para criar e configurar domínios do Amazon ES em HTTP. Além disso, é possível usar a AWS CLI e o console para configurar domínios do Amazon ES. Para obter mais informações, consulte Criação e configuração de domínios do Amazon ES.
Actions
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 Elasticsearch Service. A descrição de cada operação também inclui o método HTTP necessário.
Todas as solicitações de serviço de configuração devem ser assinadas. Para obter mais informações, consulte Assinatura de solicitações de serviço do Amazon Elasticsearch neste guia e Processo de autenticação do Signature Version 4 no AWS General Reference.
AcceptInboundCrossClusterSearchConnection
Permite que o proprietário do domínio de destino aceite uma solicitação de conexão de pesquisa entre clusters de entrada.
Syntax
PUT https://es.us-east-1
.amazonaws.com/2015-01-01/es/ccs/inboundConnection/{ConnectionId}
/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 Amazon ES. Para obter mais informações, consulte Marcação de domínios do Amazon ES.
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-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
Elementos de resposta
A operação AddTags
não retorna uma estrutura de dados.
AssociatePackage
Associa um pacote a um domínio do Amazon ES.
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-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 |
CreateElasticsearchDomain
Cria um domínio do Amazon ES. Para obter mais informações, consulte Criação de domínios do Amazon ES.
Se tentar criar um domínio do Amazon ES e um domínio com o mesmo nome que já existe, a API não relatará um erro. Em vez disso, ela retornará detalhes do domínio existente.
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-01-01/es/domain
{
"ElasticsearchClusterConfig": {
"ZoneAwarenessConfig": {
"AvailabilityZoneCount": 3
},
"ZoneAwarenessEnabled": true|false
,
"InstanceCount": 3
,
"DedicatedMasterEnabled": true|false
,
"DedicatedMasterType": "c5.large.elasticsearch
",
"DedicatedMasterCount": 3
,
"InstanceType": "r5.large.elasticsearch
",
"WarmCount": 3
,
"WarmEnabled": true|false
,
"WarmType": "ultrawarm1.large.elasticsearch
"
},
"EBSOptions": {
"EBSEnabled": true|false
,
"VolumeType": "io1|gp2|standard
",
"Iops": 1000
,
"VolumeSize": 35
},
"EncryptionAtRestOptions": {
"Enabled": true|false
,
"KmsKeyId":"arn:aws:kms:us-east-1:123456789012:alias/my-key
"
},
"SnapshotOptions": {
"AutomatedSnapshotStartHour": 3
},
"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
"
},
"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/CognitoAccessForAmazonES
"
},
"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": {
"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": "0 0 ? * 3 *
"
}]
},
"ElasticsearchVersion": "7.9
",
"TagList": [
{
"Key": "stack
",
"Value": "prod
"
}
],
"ElasticsearchVersion": "7.1
",
"DomainName": "my-domain
",
"AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"123456789012
\"]},\"Action\":[\"es:es: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 Amazon ES a ser criado. |
ElasticsearchVersion |
String | Não | Versão de Elasticsearch. Quando não especificada, a 1.5 é usada como padrão. Para obter a lista completa de versões compatíveis, consulte Versões Elasticsearch compatíveis. |
ElasticsearchClusterConfig |
ElasticsearchClusterConfig | Não | Contêiner para a configuração de cluster de um domínio do Amazon ES. |
EBSOptions |
EBSOptions | Não | Contêiner para os parâmetros necessários para permitir armazenamento EBS para um domínio do Amazon ES. |
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 Amazon ES criará o domínio com um endpoint público. Para saber mais, consulte Suporte a VPC para domínios do Amazon Elasticsearch Service. |
CognitoOptions |
CognitoOptions | Não | Pares de chave/valor para configurar o Amazon ES para usar a autenticação Amazon Cognito para o Kibana. |
AccessPolicies |
String | Não | Documento de política do IAM que especifica políticas de acesso para o novo domínio do Amazon ES. Para obter mais informações, consulte Gerenciamento de identidades e acesso no Amazon Elasticsearch Service. |
SnapshotOptions |
SnapshotOptions | Não |
SUSPENSO. Para domínios executando o Elasticsearch 5.3 e posterior, o Amazon ES tira snapshots automatizados a cada hora, tornando essa configuração irrelevante. Para domínios que executam versões anteriores do Elasticsearch, o Amazon ES tira snapshots automatizados diários. Esse valor atua como um contêiner para a hora do dia em que você deseja que o serviço tire o snapshot. |
AdvancedOptions |
AdvancedOptions | Não | Pares de chave/valor para especificar opções de configuração avançada. Para obter mais informações, consulte Configuração de opções avançadas. |
LogPublishingOptions |
LogPublishingOptions | 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 minucioso. |
AutoTuneOptions |
AutoTuneOptions | Não | Opções para o ajuste automático. |
TagList |
TagList | Não | Lista de tags que você deseja adicionar ao domínio na criação. |
Elementos de resposta
Campo | Tipo de dados |
---|---|
DomainStatus |
ElasticsearchDomainStatus |
CreateOutboundCrossClusterSearchConnection
Cria uma conexão de pesquisa entre clusters de um domínio de origem para um domínio de destino.
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-01-01/es/ccs/outboundConnection
{
"ConnectionAlias": "StringValue
",
"SourceDomainInfo": {
"DomainName": "Domain-name
",
"Region": "us-east-1
"
},
"DestinationDomainInfo": {
"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. |
SourceDomainInfo |
Objeto | Sim | Nome e região do domínio de origem. |
DestinationDomainInfo |
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. |
CrossClusterSearchConnectionId |
String | O ID da conexão de saída. |
CreatePackage
Adicione um pacote para uso com domínios do Amazon ES.
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-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 |
DeleteElasticsearchDomain
Exclui um domínio do Amazon ES e todos os respectivos dados. Não é possível recuperar um domínio depois que ele é excluído.
Syntax
DELETE https://es.us-east-1
.amazonaws.com/2015-01-01/es/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 Amazon ES 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 |
ElasticsearchDomainStatus |
DeleteElasticsearchServiceRole
Exclui uma função vinculada ao serviço entre o Amazon ES e o Amazon EC2. Essa função fornece permissões do Amazon ES 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.
Essa ação só funciona se nenhum domínio estiver usando a função vinculada ao serviço.
Syntax
DELETE https://es.us-east-1
.amazonaws.com/2015-01-01/es/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.
DeleteInboundCrossClusterSearchConnection
Permite que o proprietário do domínio de destino exclua uma conexão de pesquisa entre clusters de entrada existente.
Syntax
DELETE https://es.us-east-1
.amazonaws.com/2015-01-01/es/ccs/inboundConnection/{ConnectionId}
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. |
DeleteOutboundCrossClusterSearchConnection
Permite que o proprietário do domínio de origem exclua uma conexão de pesquisa entre clusters de saída existente.
Syntax
DELETE https://es.us-east-1
.amazonaws.com/2015-01-01/es/ccs/outboundConnection/{ConnectionId}
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 Amazon ES. O pacote não deve ser associado a nenhum domínio do Amazon ES.
Syntax
DELETE https://es.us-east-1
.amazonaws.com/2015-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 que o Auto-Tune fez no domínio.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-01-01/es/domain/domain-name
/autoTunes
Parâmetros de solicitação
Parâmetro | Tipo de dados | Obrigatório? | Descrição |
---|---|---|---|
DomainName |
DomainName | Sim | Nome do Amazon ES domínio sobre o qual você deseja obter detalhes do 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 |
Lista | 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.
|
DescribeElasticsearchDomain
Descreve a configuração para o domínio do Amazon ES especificado, como ID de domínio, endpoint de serviço do domínio e ARN do domínio.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-01-01/es/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 Amazon ES 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 |
---|---|
DomainStatus |
ElasticsearchDomainStatus |
DescribeElasticsearchDomainConfig
Exibe a configuração de um domínio do Amazon ES.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-01-01/es/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 Amazon ES 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 |
ElasticsearchDomainConfig |
DescribeElasticsearchDomains
Descreve a configuração do domínio para até cinco domínios do Amazon ES especificados. As informações incluem ID de domínio, endpoint de serviço do domínio e ARN do domínio.
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-01-01/es/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ínio do Amazon ES. |
Elementos de resposta
Campo | Tipo de dados |
---|---|
DomainStatusList |
ElasticsearchDomainStatusList |
DescribeElasticsearchInstanceTypeLimits
Descreve os limites de número de instâncias, armazenamento e nós principais para uma determinada versão do Elasticsearch e tipo de instância.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-01-01/es/instanceTypeLimits/elasticsearch-version
/instance-type
?domainName=domain-name
Parâmetros de solicitação
Parâmetro | Tipo de dados | Obrigatório? | Descrição |
---|---|---|---|
ElasticsearchVersion |
String | Sim | ElasticsearchVersão do . Para ver uma lista das versões com suporte, consulte Versões Elasticsearch compatíveis. |
InstanceType |
String | Sim | Tipo de instância. Para visualizar tipos de instância por região, consulte Definição de preço do Amazon Elasticsearch 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.
|
DescribeInboundCrossClusterSearchConnections
Lista todas as conexões de pesquisa entre clusters de entrada para um domínio de destino.
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-01-01/es/ccs/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 | Sim | Lista de nomes de filtros e valores que você pode usar para as solicitações “Descrever”.
Os seguintes campos são compatíveis: cross-cluster-search-connection-id , source-domain-info.domain-name , source-domain-info.owner-id source-domain-info.region , e destination-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.
|
DescribeOutboundCrossClusterSearchConnections
Lista todas as conexões de pesquisa entre clusters de saída para um domínio de origem.
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-01-01/es/ccs/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 | Sim | Lista de nomes de filtros e valores que você pode usar para as solicitações “Descrever”.
Os seguintes campos são compatíveis: cross-cluster-search-connection-id , source-domain-info.domain-name , source-domain-info.owner-id source-domain-info.region , e destination-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 Amazon ES. Inclui opções de filtragem, limitação do número de resultados e paginação.
Syntax
POST https://es.
us-east-1
.amazonaws.com/2015-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 |
Filters | 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 |
Lista | Lista de objetos PackageDetails. |
DescribeReservedElasticsearchInstanceOfferings
Descreve as ofertas de instâncias reservadas disponíveis para determinada região.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-01-01/es/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 |
---|---|---|
ReservedElasticsearchInstanceOfferings |
ReservedElasticsearchInstanceOfferings | Contêiner de todas as informações sobre uma oferta de instância reservada. Para obter mais informações, consulte Comprar instâncias reservadas (CLI da AWS). |
DescribeReservedElasticsearchInstances
Descreve a instância que foi reservada em determinada região.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-01-01/es/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 |
---|---|---|
ReservedElasticsearchInstances |
ReservedElasticsearchInstances |
Contêiner de todas as informações sobre a instância reservada. Para obter mais informações, consulte Comprar instâncias reservadas (CLI da AWS). |
DissociatePackage
Remove o pacote do domínio especificado do Amazon ES. O pacote não deve estar em uso com nenhum índice do ES para que a dissociação tenha êxito. O pacote ainda estará disponível no serviço Amazon ES para associação posterior.
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-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 |
GetCompatibleElasticsearchVersions
Retorna um mapa de versões do Elasticsearch e as versões para as quais você pode atualizar.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-01-01/es/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 |
---|---|---|
CompatibleElasticsearchVersions |
Mapa | Um mapa de versões do Elasticsearch e as versões para as quais você pode atualizá-las:
|
GetPackageVersionHistory
Retorna um mapa de versões do Elasticsearch e as versões para as quais você pode atualizar.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-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, atualizações tmies e versões para o pacote
determinado:
|
GetUpgradeHistory
Retorna uma lista das 10 operações de atualização mais recentes do domínio.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-01-01/es/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 do Elasticsearch do domínio.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-01-01/es/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 do domínio. |
ListDomainNames
Exibe o nome de todos os domínios do Amazon ES pertencentes ao usuário atual na região ativa.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-01-01/domain
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
Campo | Tipo de dados | Descrição |
---|---|---|
DomainNameList |
DomainNameList | Nome de todos os domínios do Amazon ES pertencentes ao usuário atual. |
ListDomainsForPackage
Lista todos os domínios do Amazon ES aos quais um pacote está associado.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-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 |
Lista | 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.
|
ListElasticsearchInstanceTypeDetails
Lista todos os tipos de instância Elasticsearch que são compatíveis com uma determinada versão do Elasticsearch e os recursos com que esses tipos de instância são compatíveis.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-01-01/es/instanceTypeDetails/elasticsearch-version
?domainName=domain-name
&maxResults=max-results
&nextToken=next-token
Parâmetros de solicitação
Parâmetro | Tipo de dados | Obrigatório? | Descrição |
---|---|---|---|
ElasticsearchVersion |
String | Sim | A versão do Elasticsearch. |
DomainName |
String | Não | O nome do domínio do Amazon ES. |
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 |
---|---|---|
ElasticsearchInstanceTypes |
Lista | Lista de tipos de instância compatíveis com a versão específica do Elasticsearch e os recursos com que esses tipos de instância são compatíveis. |
NextToken |
String |
Usado para paginação. Necessário apenas se uma chamada de API anterior tiver produzido
um resultado que contém |
ListElasticsearchInstanceTypes (Preterido)
Lista todos os tipos de instância Elasticsearch que são suportados para uma determinada versão do Elasticsearch. Essa ação está obsoleta. Use ListElasticsearchInstanceTypeDetails.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-01-01/es/instanceTypes/elasticsearch-version
?domainName=domain-name
&maxResults=max-results
&nextToken=next-token
Parâmetros de solicitação
Parâmetro | Tipo de dados | Obrigatório? | Descrição |
---|---|---|---|
ElasticsearchVersion |
String | Sim | A versão do Elasticsearch. |
DomainName |
String | Não | O nome do domínio do Amazon ES. |
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 |
---|---|---|
ElasticsearchInstanceTypes |
Lista | Lista de tipos de instância suportados para a versão determinada do Elasticsearch. |
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.
|
ListElasticsearchVersions
Lista todas as versões do Elasticsearch com suporte no Amazon ES.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-01-01/es/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.
Elementos de resposta
Campo | Tipo de dados | Descrição |
---|---|---|
ElasticsearchVersions |
Lista | Lista todas as versões do Elasticsearch com suporte. |
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 Amazon ES.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-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 Amazon ES.
Syntax
GET https://es.us-east-1
.amazonaws.com/2015-01-01/tags?arn=domain-arn
Parâmetros de solicitação
Parâmetro | Tipo de dados | Obrigatório? | Descrição |
---|---|---|---|
ARN |
ARN | Sim | Nome de recurso da Amazon (ARN) para o domínio do Amazon ES. |
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 obter mais informações, consulte Marcação de domínios do Amazon Elasticsearch Service. |
PurchaseReservedElasticsearchInstanceOffering
Compra uma instância reservada.
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-01-01/es/purchaseReservedInstanceOffering
{
"ReservationName" : "my-reservation
",
"ReservedElasticsearchInstanceOfferingId" : "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 | Tipo de dados | Obrigatório? | Descrição |
---|---|---|---|
ReservationName |
String | Sim | Um nome descritivo para a reserva. |
ReservedElasticsearchInstanceOfferingId
|
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. |
ReservedElasticsearchInstanceId |
String | O ID da reserva. |
RejectInboundCrossClusterSearchConnection
Permite que o proprietário do domínio de destino rejeite uma solicitação de conexão de pesquisa entre clusters de entrada.
Syntax
PUT https://es.us-east-1
.amazonaws.com/2015-01-01/es/ccs/inboundConnection/{ConnectionId}
/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 Amazon ES.
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-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 de recurso da Amazon (ARN) de um domínio do Amazon ES. Para obter mais informações, consulte Identifiers for IAM Entities em Using 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 Amazon ES. |
Elementos de resposta
A operação RemoveTags
não retorna um elemento de resposta.
StartElasticsearchServiceSoftwareUpdate
Agenda uma atualização do software de serviço para um domínio do Amazon ES.
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-01-01/es/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 Amazon ES que 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. |
StopElasticsearchServiceSoftwareUpdate
Interrompe uma atualização do software de serviço agendado para um domínio do Amazon
ES. Somente funciona se o domínio UpdateStatus
é PENDING_UPDATE
.
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-01-01/es/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 Amazon ES que 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. |
UpdateElasticsearchDomainConfig
Modifica a configuração de um domínio do Amazon ES, como o tipo de instância e o número de instâncias. É necessário especificar somente os valores que você deseja atualizar.
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-01-01/es/domain/<DOMAIN_NAME>/config
{
"ElasticsearchClusterConfig": {
"ZoneAwarenessConfig": {
"AvailabilityZoneCount": 3
},
"ZoneAwarenessEnabled": true|false
,
"InstanceCount": 3
,
"DedicatedMasterEnabled": true|false
,
"DedicatedMasterType": "c5.large.elasticsearch
",
"DedicatedMasterCount": 3
,
"InstanceType": "r5.large.elasticsearch
",
"WarmCount": 6
,
"WarmType": "ultrawarm1.medium.elasticsearch
"
},
"EBSOptions": {
"EBSEnabled": true|false
,
"VolumeType": "io1|gp2|standard
",
"Iops": 1000
,
"VolumeSize": 35
},
"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
"
},
"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/CognitoAccessForAmazonES
"
},
"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": {
"InternalUserDatabaseEnabled": true|false
,
"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": 4104152288000
,
"Duration": {
"Value": 2,
"Unit": "HOURS"
},
"CronExpressionForRecurrence": "30 11 ? * 3,6 *
"
}]
},
"AutoTuneOptions": {
"DesiredState": "ENABLED|DISABLED
",
"MaintenanceSchedules": [{
"StartAt": 1234567890
,
"Duration": {
"Value": 2
,
"Unit": "HOURS"
},
"CronExpressionForRecurrence": "* * * * *
"
}],
"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/*\"}]}
"
}
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 Amazon ES para a qual você deseja atualizar a configuração. |
ElasticsearchClusterConfig |
ElasticsearchClusterConfig | 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 Amazon ES para funcionar com uma VPC. Para saber mais, consulte Suporte a VPC para domínios do Amazon Elasticsearch Service. |
SnapshotOptions |
SnapshotOptions | Não | SUSPENSO. Hora durante a qual o serviço tira um snapshot automatizado diário dos índices no domínio do Amazon ES. |
AdvancedOptions |
AdvancedOptions | Não | Pares de chave/valor para especificar opções de configuração avançada. Para obter mais informações, consulte Configuração de opções avançadas. |
AccessPolicies |
String | Não | Especifica as políticas de acesso para o domínio do Amazon ES. Para obter 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 Amazon ES para usar a autenticação Amazon Cognito para o Kibana. |
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 minucioso. |
AutoTuneOptions |
AutoTuneOptions | Não | Opções para o ajuste automático. |
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. |
Elementos de resposta
Campo | Tipo de dados |
---|---|
DomainConfig |
ElasticsearchDomainConfig |
UpdatePackage
Atualizar um pacote para uso com Amazon ES domínios do .
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-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 |
UpgradeElasticsearchDomain
Atualiza um domínio do Amazon ES para uma nova versão do Elasticsearch. Como alternativa, verifica a qualificação da atualização.
Syntax
POST https://es.us-east-1
.amazonaws.com/2015-01-01/es/upgradeDomain
{
"DomainName": "domain-name
",
"TargetVersion": "7.8
",
"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 Amazon ES que você deseja atualizar. |
TargetVersion |
String | Sim | ElasticsearchVersão do para a qual você deseja atualizar. Consulte GetCompatibleElasticsearchVersions. |
PerformCheckOnly |
Booleano | Não | O padrão é false . Se for true , o Amazon ES verificará a elegibilidade do domínio, mas não executará a atualização.
|
Elementos de resposta
Campo | Tipo de dados | Descrição |
---|---|---|
UpgradeElasticsearchDomainResponse |
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 Elasticsearch.
Campo | Tipo de dados | Descrição |
---|---|---|
rest.action.multi.allow_explicit_index |
Par de chave/valor:
|
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:
|
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:
|
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 Lucene. 1.024 é o padrão. 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 |
AdvancedSecurityOptions
Campo | Tipo de dados | Descrição |
---|---|---|
Enabled |
Booleano | Verdadeiro para habilitar o controle de acesso minucioso. |
InternalUserDatabaseEnabled |
Booleano | Verdadeiro para habilitar o banco de dados interno de usuários. |
MasterUserOptions |
MasterUserOptions | Contêiner para informações sobre o usuário mestre. |
SAMLOptions |
SAMLOptions | Contêiner para obter informações sobre a configuração do SAML para o Kibana. |
ARN
Campo | Tipo de dados | Descrição |
---|---|---|
ARN |
String | Nome de recurso da Amazon (ARN) de um domínio do Amazon ES. Para obter mais informações, consulte IAM ARNs na documentação do AWS Identity and Access Management. |
AutoTuneOptions
Campo | Tipo de dados | Descrição |
---|---|---|
DesiredState |
String | ENABLED ou DISABLED .
|
MaintenanceSchedules |
Lista |
Uma lista de programações de manutenção durante as quais o Auto-Tune pode implantar alterações:
As programações de manutenção são substituídas, não anexadas. Se a solicitação não
incluir programações, ela excluirá todas as programações existentes. Para preservar
programações existentes, primeiro faça uma chamada para DescribeElasticsearchDomainConfig e use a
|
RollbackOnDisable |
String | Ao desabilitar o Ajuste automático, especifique NO_ROLLBACK para reter todas as configurações anteriores do Ajuste automático ou DEFAULT_ROLLBACK para reverter para os Amazon ES padrões.
Se você especificar DEFAULT_ROLLBACK, deverá incluir um |
CognitoOptions
Campo | Tipo de dados | Descrição |
---|---|---|
Enabled |
Booleano | Determina se vai habilitar ou desabilitar a autenticação do Amazon Cognito para o Kibana. Consulte Amazon CognitoAutenticação do para o Kibana. |
UserPoolId |
String | O ID de grupo de usuários do Amazon Cognito que você deseja que o Amazon ES use para a autenticação do Kibana. |
IdentityPoolId |
String | O ID de grupo de identidades do Amazon Cognito que você deseja que o Amazon ES use para a autenticação do Kibana. |
RoleArn |
String | A função AmazonESCognitoAccess que permite que o Amazon ES configure seus grupos de usuários e de identidades.
|
CreateElasticsearchDomainRequest
Contêiner de parâmetros necessários para a operação de serviço CreateElasticsearchDomain
.
Campo | Tipo de dados | Descrição |
---|---|---|
DomainName |
DomainName | Nome do domínio do Amazon ES a ser criado. |
ElasticsearchClusterConfig |
ElasticsearchClusterConfig | Contêiner para a configuração de cluster de um domínio do Amazon ES. |
EBSOptions |
EBSOptions | Contêiner para os parâmetros necessários para permitir armazenamento EBS para um domínio do Amazon ES. |
AccessPolicies |
String | Documento de política do IAM que especifica as políticas de acesso para o novo domínio do Amazon ES. Para obter 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 Amazon ES 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 Amazon ES para usar a autenticação Amazon Cognito para o Kibana. |
NodeToNodeEncryptionOptions |
NodeToNodeEncryptionOptions | Especifique true para ativar a criptografia de nó a nó.
|
DomainEndpointOptions
Campo | Tipo de dados | Descrição |
---|---|---|
EnforceHTTPS |
Booleano | 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:
|
CustomEndpointEnabled |
Booleano | Se um endpoint personalizado deve ser habilitado para o domínio. |
CustomEndpoint |
String | O URL totalmente qualificado para o endpoint personalizado. |
CustomEndpointCertificateArn |
String | O ARN do certificado de segurança, gerenciado no ACM. |
DomainID
Tipo de dados | Descrição |
---|---|
String | Identificador exclusivo para um domínio do Amazon ES. |
DomainName
Nome de um domínio do Amazon ES.
Tipo de dados | Descrição |
---|---|
String | Nome de um domínio do Amazon ES. 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 de nomes de domínio do Amazon ES.
Tipo de dados | Descrição |
---|---|
String Array | Matriz de domínios do Amazon ES no formato a seguir:
|
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 | Time stamp | 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 Amazon ES. É o mesmo que synonym_path para arquivos de dicionário.
|
EBSOptions
Contêiner para os parâmetros necessários para permitir armazenamento EBS para um domínio do Amazon ES.
Campo | Tipo de dados | Descrição |
---|---|---|
EBSEnabled |
Booleano | Indica se os volumes do EBS estão anexados a nós de dados em um domínio do Amazon ES. |
VolumeType |
String | Especifica o tipo de volume do EBS anexado a nós de dados. |
VolumeSize |
String | Especifica o tamanho (em GiB) do volume do EBS anexado a nós de dados. |
Iops |
String | Especifica o desempenho de referência de entrada/saída (E/S)dos volumes do EBS anexados aos nós de dados. Aplicável somente ao tipo de volume IOPS provisionado do EBS. |
ElasticsearchClusterConfig
Contêiner para a configuração de cluster de um domínio do Amazon ES.
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 |
Booleano | 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 obter mais informações, consulte Sobre os nós principais dedicados.
|
DedicatedMasterType |
String | Amazon ESTipo de instância do de nós principais dedicados no cluster. |
DedicatedMasterCount |
Inteiro | Número de nós principais dedicados no cluster. |
ZoneAwarenessEnabled |
Booleano | Indica se várias zonas de disponibilidade estão habilitadas. Para obter mais informações, consulte Configuração de um domínio Multi-AZ. |
ZoneAwarenessConfig |
ZoneAwarenessConfig | Contêiner para opções de configuração de reconhecimento da zona. Necessário somente
se ZoneAwarenessEnabled for true .
|
WarmEnabled |
Booleano | 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. |
ElasticsearchDomainConfig
Contêiner para a configuração de um domínio do Amazon ES.
Campo | Tipo de dados | Descrição |
---|---|---|
ElasticsearchVersion |
String | ElasticsearchVersão do . |
ElasticsearchClusterConfig |
ElasticsearchClusterConfig | Contêiner para a configuração de cluster de um domínio do Amazon ES. |
EBSOptions |
EBSOptions | Contêiner para opções do EBS configuradas para um domínio do Amazon ES. |
AccessPolicies |
String | Especifica as políticas de acesso para o domínio do Amazon ES. Para obter mais informações, consulte Configuração de políticas de acesso. |
SnapshotOptions |
SnapshotOptions | SUSPENSO. Hora durante a qual o serviço tira um snapshot automatizado diário dos índices no domínio do Amazon ES. |
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. |
ElasticsearchDomainStatus
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 Amazon ES. |
DomainName |
DomainName | Nome de um domínio do Amazon ES. 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 de recurso da Amazon (ARN) de um domínio do Amazon ES. Para obter mais informações, consulte Identifiers for IAM Entities em Using AWS Identity and Access Management. |
Created |
Booleano | Status de criação de um domínio do Amazon ES. True se a criação do domínio estiver concluída. False se a criação do domínio ainda estiver em andamento.
|
Deleted |
Booleano | Status de exclusão de um domínio do Amazon ES. 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 ao domínio usado para enviar solicitações de índice, pesquisa e upload de dados a um domínio do Amazon ES. |
Endpoints |
EndpointsMap | O par chave-valor existente quando o domínio do Amazon ES usa VPC endpoints. |
Processing |
Booleano | Status de uma alteração na configuração de um domínio do Amazon ES. 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.
|
ElasticsearchVersion |
String | ElasticsearchVersão do . |
ElasticsearchClusterConfig |
ElasticsearchClusterConfig | Contêiner para a configuração de cluster de um domínio do Amazon ES. |
EBSOptions |
EBSOptions | Contêiner para os parâmetros necessários para permitir armazenamento EBS para um domínio do Amazon ES. |
AccessPolicies |
String | Documento de política do IAM que especifica políticas de acesso para o novo domínio do Amazon ES. Para obter 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 Amazon ES. |
VPCOptions |
VPCDerivedInfo | Informações derivadas pelo Amazon ES 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 Amazon ES para usar a autenticação Amazon Cognito para o Kibana. |
NodeToNodeEncryptionOptions |
NodeToNodeEncryptionOptions | Se a criptografia de nó a nó estiver ativada ou desativada. |
UpgradeProcessing |
Booleano | True (Verdadeiro) se uma atualização para uma nova versão do Elasticsearch estiver em andamento. |
ServiceSoftwareOptions |
ServiceSoftwareOptions | O status do software de serviço do domínio. |
ElasticsearchDomainStatusList
Lista que contém o status de cada domínio especificado do Amazon ES.
Campo | Tipo de dados | Descrição |
---|---|---|
DomainStatusList |
ElasticsearchDomainStatus | Lista que contém o status de cada domínio especificado do Amazon ES. |
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 |
Booleano | 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 Amazon ES residir 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. |
Filters
Filtra os pacotes incluídos em uma resposta DescribePackages.
Campo | Tipo de dados | Descrição |
---|---|---|
Name |
String | Qualquer campo do PackageDetails. |
Value |
Lista | Uma lista de valores do campo especificado. |
LogPublishingOptions
Especifica se o domínio do Amazon ES publica o aplicativo Elasticsearch e os logs lentos no Amazon CloudWatch. Você ainda tem que habilitar a coleta de logs lentos usando a API REST do Elasticsearch. Para saber mais, consulte Configuração dos limites de logs do Elasticsearch 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 índice de log lento do Elasticsearch deve ser publicado lá:
|
SEARCH_SLOW_LOGS |
Chave-valor |
Dois pares de chave-valor que definem o grupo de logs do CloudWatch e se a pesquisa do Elasticsearch deve ser publicada lá:
|
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 Elasticsearch devem ser publicados lá:
|
MasterUserOptions
Campo | Tipo de dados | Descrição |
---|---|---|
MasterUserARN |
String | ARN para o usuário mestre. Especifique somente se InternalUserDatabaseEnabled estiver false em AdvancedSecurityOptions.
|
MasterUserName |
String | O nome de usuário para o usuário mestre. Especifique somente se InternalUserDatabaseEnabled estiver true em AdvancedSecurityOptions.
|
MasterUserPassword |
String | A senha para o usuário mestre. 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 |
Booleano | Habilitar co true .
|
OptionState
Estado de uma atualização para opções avançadas de um domínio do Amazon ES.
Campo | Tipo de dados | Descrição |
---|---|---|
OptionStatus |
String | Um de três valores válidos:
|
OptionStatus
Status de uma atualização de opções de configuração para um domínio do Amazon ES.
Campo | Tipo de dados | Descrição |
---|---|---|
CreationDate |
Time stamp | Data e hora em que o domínio do Amazon ES foi criado. |
UpdateDate |
Time stamp | Data e hora em que o domínio do Amazon ES foi atualizado. |
UpdateVersion |
Inteiro | Número inteiro que especifica a versão mais recente da entidade. |
State |
OptionState | Estado de uma atualização de opções de configuração para um domínio do Amazon ES. |
PendingDeletion |
Booleano | Indica se o serviço está processando uma solicitação para excluir permanentemente o domínio do Amazon ES e todos os seus recursos. |
PackageDetails
Informações básicas sobre um pacote.
Campo | Tipo de dados | Descrição |
---|---|---|
CreatedAt |
Time stamp | Nome do bucket que contém o pacote. |
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 Amazon ES.
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 |
Booleano | Se a autenticação SAML deve ser habilitada para o Kibana. |
MasterUserName |
String | Esse nome de usuário do IdP SAML recebe permissões completas para o cluster, equivalente a um novo usuário mestre. |
MasterBackendRole |
String | Essa função de back-end do IdP SAML recebe permissões completas para o cluster, equivalente a um novo usuário mestre. |
Idp |
Objeto |
Contêiner de informações do provedor de identidade. Contém dois elementos :
|
RolesKey |
String | Elemento da declaração SAML a ser usado para funções de back-end. O padrão é roles .
|
SubjectKey |
String | Elemento da declaraçã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 |
Booleano | Se uma atualização de software do serviço está disponível ou não para o seu domínio. |
Cancellable |
Booleano | Se você tiver solicitado um domínio de atualização, se você pode cancelar ou não a atualização. |
AutomatedUpdateDate |
Time stamp | O horário Epoch em que a janela de implantação fecha para as atualizações necessárias. Após esse tempo, Amazon ES 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 |
Booleano | Se a atualização de software do serviço é opcional. |
ServiceURL
Endpoint específico ao domínio usado para enviar solicitações de índice, pesquisa e upload de dados a um domínio do Amazon ES.
Campo | Tipo de dados | Descrição |
---|---|---|
ServiceURL |
String | Endpoint específico ao domínio usado para enviar solicitações de índice, pesquisa e upload de dados a um domínio do Amazon ES. |
SnapshotOptions
SUSPENSO. Consulte Criação de snapshots de Amazon ES índice. 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 Amazon ES.
Campo | Tipo de dados | Descrição |
---|---|---|
AutomatedSnapshotStartHour |
Inteiro | SUSPENSO. Hora durante a qual o serviço tira um snapshot automatizado diário dos índices no domínio do Amazon ES. |
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 Amazon ES ao qual elas são anexadas. Para obter mais informações, consulte Marcação de domínios do Amazon Elasticsearch 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 Amazon ES. |
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 ao criar 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 Guia 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 Noções básicas da VPC e da sub-rede no Guia do usuário da Amazon VPC. |
SecurityGroupIds |
StringList | Uma lista de IDs de security group associados aos VPC endpoints do domínio. Para obter mais informações, consulte Grupos de segurança da 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 Guia do usuário da Amazon VPC. |
SecurityGroupIds |
StringList | Uma lista de IDs de security group associados aos VPC endpoints do domínio. Se você não fornecer um ID de security group, o Amazon ES usa o security group padrão de sua VPC. Para saber mais, consulte Grupos de segurança para sua VPC no Guia 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 .
|
Errors
Amazon ESO lança 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 |
Lançada quando se tenta criar ou acessar um sub-recurso do domínio do Amazon ES que é inválido ou incompatível. Retorna código de status HTTP 409. |
LimitExceededException |
Lançada ao tenta criar recursos e sub-recursos do domínio do Amazon ES 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 |
Lançada quando um cliente tenta criar um recurso que já existe em um domínio do Amazon ES. Retorna código de status HTTP 400. |