Riferimento dell'API di configurazione per il servizio OpenSearch di Amazon - Amazon OpenSearch Service

Riferimento dell'API di configurazione per il servizio OpenSearch di Amazon

In queste informazioni di riferimento vengono descritte le azioni, i tipi di dati e gli errori nell'API di configurazione del servizio OpenSearch di Amazon. L'API di configurazione è un'API REST che è possibile usare per creare e configurare domini OpenSearch Service via HTTP. Per configurare domini OpenSearch Service, è possibile usare anche la AWS CLI e la console. Per ulteriori informazioni, consultare Creazione e gestione di domini Amazon OpenSearch Service.

Autenticazione

Tutte le richieste del servizio di configurazione devono essere firmate. Per ulteriori informazioni, consulta Firma di richieste del servizio OpenSearch di Amazon in questa guida e Processo di firma di Signature versione 4 in Riferimenti generali di AWS.

Nuova versione dell'API e azioni obsolete

Importante

Le seguenti azioni sono state dichiarate obsolete nella versione 2021-01-01 dell'API del servizio OpenSearch di Amazon e sostituite da endpoint più concisi e indipendenti dal motore. Tuttavia, la AWS CLI e l'API di configurazione continuano ad accettarle.

Azione obsoleta Sostituzione
AcceptInboundCrossClusterSearchConnection AcceptInboundConnection
CreateElasticsearchDomain CreateDomain
CreateOutboundCrossClusterSearchConnection CreateOutboundConnection
CreateElasticsearchServiceRole Nessuna sostituzione. Utilizza l'API IAM per creare i ruoli collegati ai servizi.
DeleteElasticsearchDomain DeleteDomain
DeleteElasticsearchServiceRole Nessuna sostituzione. Utilizzare l'API IAM per eliminare i ruolo collegati ai servizi.
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

Operazioni

La tabella seguente fornisce un riferimento rapido per il metodo HTTP necessario per ogni operazione per l'interfaccia REST all'API di configurazione di Amazon OpenSearch Service. La descrizione di ogni operazione include inoltre il metodo HTTP richiesto.

AcceptInboundConnection

Consente al proprietario del dominio di destinazione di accettare una richiesta di connessione di ricerca tra cluster in ingresso.

Sintassi

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

Parametri della richiesta

Questa operazione non usa parametri della richiesta HTTP.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
CrossClusterSearchConnection Oggetto Dettagli della connessione in ingresso.

AddTags

Collega i tag di risorsa a un dominio OpenSearch Service. Per ulteriori informazioni, consultare Assegnazione di tag dei domini Amazon OpenSearch Service.

Sintassi

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

Parametri della richiesta

Questa operazione non utilizza parametri richiesta.

Corpo della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
TagList TagList Elenco dei tag delle risorse.
ARN ARN Il nome della risorsa Amazon (ARN) per il dominio del servizio OpenSearch a cui collegare i tag risorsa.

Elementi della risposta

L'operazione AddTags non restituisce una struttura di dati.

AssociatePackage

Associa un pacchetto a un dominio OpenSearch Service.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
PackageID Stringa ID interno del pacchetto che si desidera associare a un dominio. Utilizzare DescribePackages per trovare questo valore.
DomainName DomainName Nome del dominio a cui si desidera associare il pacchetto.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati
DomainPackageDetails DomainPackageDetails

CreateDomain

Crea un dominio OpenSearch Service. Per ulteriori informazioni, consultare Creazione di domini OpenSearch Service.

Nota

Se si prova a creare un dominio OpenSearch Service ed è già presente un dominio con lo stesso nome, l'API non segnala un errore. Restituisce invece i dettagli per il dominio esistente.

Sintassi

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/*\"}]}" }

Parametri della richiesta

Questa operazione non usa parametri della richiesta HTTP.

Corpo della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
DomainName DomainName Nome del dominio OpenSearch Service da creare.
EngineVersion Stringa No Versione di OpenSearch o Elasticsearch, nel formato Elasticsearch_X.Y o OpenSearch_x.y. Per impostazione predefinita, viene ripristinata la versione più recente di OpenSearch. Per l'elenco completo delle versioni supportate, consulta Versioni supportate di OpenSearch ed Elasticsearch.
ClusterConfig ClusterConfig No Container per la configurazione cluster di un dominio OpenSearch Service.
EBSOptions EBSOptions No Container per i parametri necessari per abilitare l'archiviazione basata su EBS per un dominio OpenSearch Service.
VPCOptions VPCOptions No Container per i valori necessari per configurare i domini di accesso VPC. Se questi valori non vengono specificati, OpenSearch Service crea il dominio con un endpoint pubblico. Per ulteriori informazioni, consultare Avvio dei domini Amazon OpenSearch Service all'interno di un VPC.
CognitoOptions CognitoOptions No Coppie chiave-valore per configurare OpenSearch Service per l'uso dell'autenticazione Amazon Cognito per OpenSearch Dashboards.
AccessPolicies Stringa No Documento di policy IAM che specifica le policy di accesso per il nuovo dominio OpenSearch Service. Per ulteriori informazioni, consultare Gestione di accessi e identità nel servizio OpenSearch di Amazon.
SnapshotOptions SnapshotOptions No

OBSOLETA. Container per i parametri necessari per configurare gli snapshot automatici degli indici di dominio.

AdvancedOptions AdvancedOptions No Coppie chiave-valore per specificare le opzioni di configurazione avanzate. Per ulteriori informazioni, consultare Impostazioni avanzate del cluster.
LogPublishingOptions LogPublishingOptions No Coppie chiave-valore per configurare la pubblicazione di log lenti.
EncryptionAtRestOptions EncryptionAtRestOptions No Coppie chiave-valore per abilitare la crittografia dei dati a riposo.
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions No Abilita la crittografia da nodo a nodo.
DomainEndpointOptions DomainEndpointOptions No Opzioni aggiuntive per l'endpoint del dominio, ad esempio la possibilità di richiedere il protocollo HTTPS per tutto il traffico.
AdvancedSecurityOptions AdvancedSecurityOptions No Opzioni per il controllo granulare degli accessi.
AutoTuneOptions Opzioni AutoTune No Opzioni per la regolazione automatica.
TagList TagList No Elenco di tag che si desidera aggiungere al dominio durante la creazione.

Elementi della risposta

Campo Tipo di dati
DomainStatus DomainStatus

CreateOutboundConnection

Crea una nuova connessione di ricerca tra cluster da un dominio di origine a un dominio di destinazione.

Sintassi

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" } } }

Parametri della richiesta

Questa operazione non usa parametri della richiesta HTTP.

Corpo della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
ConnectionAlias Stringa Il nome della connessione.
LocalDomainInfo Oggetto Nome e regione del dominio di origine.
RemoteDomainInfo Oggetto Nome e regione del dominio di destinazione.

Elementi della risposta

Campo Tipo di dati Descrizione
SourceDomainInfo Oggetto Nome e regione del dominio di origine.
DestinationDomainInfo Oggetto Nome e regione del dominio di destinazione.
ConnectionAlias Stringa Il nome della connessione.
ConnectionStatus Stringa Lo stato della connessione.
ConnectionId Stringa L'ID della connessione in uscita.

CreatePackage

Aggiungere un pacchetto da utilizzare con i domini OpenSearch Service.

Sintassi

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" } }

Parametri della richiesta

Questa operazione non utilizza parametri richiesta.

Corpo della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
PackageName Stringa Nome univoco del pacchetto.
PackageType Stringa Tipo di pacchetto. Al momento, supporta solo TXT-DICTIONARY.
PackageDescription Stringa No Descrizione del pacchetto.
PackageSource PackageSource Bucket S3 e chiave per il pacchetto.

Elementi della risposta

Campo Tipo di dati
PackageDetails PackageDetails

CreateElasticsearchServiceRole (obsoleto)

Crea il ruolo collegato ai servizi tra OpenSearch Service e Amazon EC2. Questa operazione è obsoleta. OpenSearch Service gestisce automaticamente la creazione e l'eliminazione dei ruoli collegati ai servizi.

Questo ruolo fornisce a OpenSearch Service le autorizzazioni per inserire gli endpoint VPC nel VPC. Un ruolo collegato al servizio è necessario per la creazione o il corretto funzionamento dei domini con endpoint VPC.

Sintassi

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

Parametri della richiesta

Questa operazione non utilizza parametri richiesta.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

L'operazione CreateServiceRole non restituisce una struttura di dati.

DeleteDomain

Elimina un dominio OpenSearch Service e tutti i relativi dati. Non è possibile, tuttavia, recuperare un dominio dopo che è stato eliminato.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
DomainName DomainName Nome del dominio OpenSearch Service che si desidera eliminare.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati
DomainStatus DomainStatus

DeleteElasticsearchServiceRole (obsoleto)

Elimina il ruolo collegato ai servizi tra OpenSearch Service e Amazon EC2. Questa operazione è obsoleta. OpenSearch Service gestisce automaticamente la creazione e l'eliminazione dei ruoli.

Questo ruolo fornisce a OpenSearch Service le autorizzazioni per inserire gli endpoint VPC nel VPC. Un ruolo collegato al servizio è necessario per la creazione o il corretto funzionamento dei domini con endpoint VPC.

Nota

Questa operazione ha esito positivo solo se non ci sono domini che usano il ruolo collegato al servizio.

Sintassi

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

Parametri della richiesta

Questa operazione non utilizza parametri richiesta.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

L'operazione DeleteElasticsearchServiceRole non restituisce una struttura di dati.

DeleteInboundConnection

Consente al proprietario del dominio di destinazione di eliminare una connessione di ricerca tra cluster in ingresso esistente.

Sintassi

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

Parametri della richiesta

Questa operazione non usa parametri della richiesta HTTP.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
CrossClusterSearchConnection Oggetto Dettagli della connessione in ingresso.

DeleteOutboundConnection

Consente al proprietario del dominio di origine di eliminare una connessione di ricerca tra cluster in uscita esistente.

Sintassi

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

Parametri della richiesta

Questa operazione non usa parametri della richiesta HTTP.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
CrossClusterSearchConnection Oggetto Dettagli della connessione in uscita.

DeletePackage

Elimina un pacchetto da OpenSearch Service. Il pacchetto non può essere associato ad alcun dominio OpenSearch Service.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
PackageID Stringa ID interno del pacchetto che si desidera eliminare. Utilizzare DescribePackages per trovare questo valore.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati
PackageDetails PackageDetails

Descrizione di Domain AutoTunes

Restituisce l'elenco delle ottimizzazioni che la regolazione automatica ha apportato al dominio.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
DomainName DomainName Nome del dominio OpenSearch Service di cui si desiderano i dettagli della regolazione automatica.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
AutoTunes Elenco Elenco delle ottimizzazioni.
NextToken Stringa Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

DescribeDomain

Descrive la configurazione di dominio per il dominio OpenSearch Service specificato, tra cui l'ID del dominio, l'endpoint del servizio del dominio e l'ARN del dominio.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
DomainName DomainName Nome del dominio OpenSearch Service che si desidera descrivere.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati
DomainStatus DomainStatus

Descrizione progresso del cambiamento di dominio

Visualizza le informazioni sullo stato di modifica della configurazione di un dominio.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
DomainName DomainName Nomi del dominio OpenSearch Service.

Corpo della richiesta

Campo Tipo di dati Obbligatorio? Descrizione
ChangeId Stringa No L'ID della modifica della configurazione. Recuperato da una richiesta UpdateDomainConfig. Se non incluso, OpenSearch Service restituisce i dettagli per la modifica della configurazione più recente.

Elementi della risposta

Campo Tipo di dati
ChangeProgressStatus Modifica dello stato di avanzamento

DescribeDomainConfig

Visualizza la configurazione di un dominio OpenSearch Service.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
DomainName DomainName Nome della configurazione del dominio OpenSearch Service che si desidera descrivere.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati
DomainConfig Configurazione dominio

DescribeDomains

Descrive la configurazione del dominio per un massimo di cinque domini OpenSearch Service specificati. Le informazioni includono l'ID del dominio, l'endpoint del servizio del dominio e l'ARN del dominio.

Sintassi

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

Parametri della richiesta

Questa operazione non usa parametri della richiesta HTTP.

Corpo della richiesta

Campo Tipo di dati Obbligatorio? Descrizione
DomainNames DomainNameList Array di nomi di dominio OpenSearch Service.

Elementi della risposta

Campo Tipo di dati
DomainStatusList DomainStatusList

DescribeInstanceTypeLimits

Descrive i limiti relativi a numero di istanze, archiviazione e nodi principali per un determinato tipo di istanza e una versione specifica di OpenSearch o Elasticsearch.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
EngineVersion Stringa Versione di OpenSearch o Elasticsearch, nel formato Elasticsearch_X.Y o OpenSearch_x.y. Per impostazione predefinita, viene ripristinata la versione più recente di OpenSearch. Per un elenco completo delle versioni supportate, consultare Versioni supportate di OpenSearch ed Elasticsearch. Per un elenco delle versioni supportate, consulta Versioni supportate di OpenSearch ed Elasticsearch.
InstanceType Stringa Tipo di istanza. Per visualizzare i tipi di istanze per regione, consulta Prezzi del servizio OpenSearch di Amazon.
DomainName DomainName No Nome di un dominio esistente. Da specificare solo se sono necessari i limiti per un dominio esistente.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
LimitsByRole Eseguire la mappatura Mappa contenente tutti i limiti di tipo di istanza applicabili. "data" si riferisce a nodi di dati. "master" si riferisce a nodi master dedicati.

DescribeInboundConnections

Elenca tutte le connessioni di ricerca tra cluster in ingresso per un dominio di destinazione.

Sintassi

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)" ] }

Parametri della richiesta

Questa operazione non usa parametri della richiesta HTTP.

Corpo della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
Filters Oggetto No Elenco dei nomi dei filtri e dei valori che è possibile utilizzare per le richieste Describe. Sono supportati i seguenti campi: connection-id, local-domain-info.domain-name, local-domain-info.owner-id, local-domain-info.region e remote-domain-info.domain-name.
MaxResults Numero intero No Limita il numero di risultati. Il valore di default è 100.
NextToken Stringa No Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

Elementi della risposta

Campo Tipo di dati Descrizione
CrossClusterSearchConnections Oggetto Elenco delle connessioni in ingresso.
NextToken Stringa Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

DescribeOutboundConnections

Elenca tutte le connessioni di ricerca tra cluster in uscita per un dominio di origine.

Sintassi

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)" ] }

Parametri della richiesta

Questa operazione non usa parametri della richiesta HTTP.

Corpo della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
Filters Oggetto No Elenco dei nomi dei filtri e dei valori che è possibile utilizzare per le richieste Describe. Sono supportati i seguenti campi: connection-id, remote-domain-info.domain-name, remote-domain-info.owner-id, remote-domain-info.region e local-domain-info.domain-name
MaxResults Numero intero No Limita il numero di risultati. Il valore di default è 100.
NextToken Stringa No Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

Elementi della risposta

Campo Tipo di dati Descrizione
CrossClusterSearchConnections Oggetto Elenco delle connessioni in uscita.
NextToken Stringa Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

DescribePackages

Descrive tutti i pacchetti disponibili per OpenSearch Service. Include opzioni per filtrare, limitare il numero di risultati e impaginare.

Sintassi

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

Parametri della richiesta

Questa operazione non utilizza parametri richiesta.

Corpo della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
Filters Filters No Restituisce solo i pacchetti che corrispondono ai valori forniti.
MaxResults Numero intero No Limita i risultati a un numero massimo di pacchetti.
NextToken Stringa No Usato per la paginazione. Necessario solo se una precedente chiamata API include un valore NextToken non nullo. Se fornito, restituisce i risultati per la pagina successiva.

Elementi della risposta

Campo Tipo di dati Descrizione
PackageDetailsList Elenco Elenco di oggetti PackageDetails

DescribeReservedInstanceOfferings

Descrive le offerte di istanze riservate disponibili per una determinata regione.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
OfferingId Stringa No ID dell'offerta.
MaxResults Numero intero No Limita il numero di risultati. Deve essere un valore compreso tra 30 e 100.
NextToken Stringa No Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
ReservedInstanceOfferings ReservedInstanceOfferings Container per tutte le informazioni sull'offerta di un'istanza riservata. Per ulteriori informazioni, consultare Acquisto di istanze riservate (AWS CLI).

DescribeReservedInstances

Descrive le istanze riservate in una determinata regione.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
ReservationId Stringa No ID della prenotazione, assegnato dopo l'acquisto di una prenotazione.
MaxResults Numero intero No Limita il numero di risultati. Deve essere un valore compreso tra 30 e 100.
NextToken Stringa No Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
ReservedInstances

ReservedInstances

Contenitore per tutte le informazioni sull'istanza che hai riservato. Per ulteriori informazioni, consultare Acquisto di istanze riservate (AWS CLI).

DissociatePackage

Rimuove il pacchetto dal dominio OpenSearch Service specificato. Perché la dissociazione riesca, il pacchetto non può essere utilizzato con alcun indice OpenSearch. Il pacchetto è ancora disponibile in OpenSearch Service per l'associazione in un secondo momento.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
PackageID Stringa ID interno del pacchetto che si desidera dissociare dal dominio. Utilizzare ListPackagesForDomain per trovare questo valore.
DomainName DomainName Nome del dominio da cui si desidera dissociare il pacchetto.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati
DomainPackageDetails DomainPackageDetails

GetCompatibleVersions

Restituisce una mappa delle versioni di OpenSearch o Elasticsearch e delle versioni cui possono essere aggiornate.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
DomainName DomainName No Nome di un dominio esistente.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
CompatibleVersions Eseguire la mappatura Una mappa delle versioni di OpenSearch o Elasticsearch e delle versioni cui possono essere aggiornate.
{ "CompatibleVersions": [{ "SourceVersion": "Elasticsearch_7.10", "TargetVersions": ["OpenSearch_1.0"] }] }

Ottieni la cronologia delle versioni del pacchetto

Restituisce una mappa delle versioni OpenSearch e delle versioni cui possono essere aggiornate.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
PackageID Stringa Nome di un dominio esistente.
MaxResults Numero intero No Limita il numero di risultati. Deve essere un valore compreso tra 30 e 100.
NextToken Stringa No Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
PackageVersionHistoryList Eseguire la mappatura Un elenco di messaggi di commit, orari di aggiornamento e versioni per il pacchetto dato:
"PackageVersionHistoryList": [ { CommitMessage": "Add new synonyms", "CreatedAt": 1.605225005466E9, "PackageVersion": "v4" } ]

GetUpgradeHistory

Restituisce un elenco delle 10 operazioni di aggiornamento più recenti del dominio.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
MaxResults Numero intero No Limita il numero di risultati. Deve essere un valore compreso tra 30 e 100.
DomainName DomainName Nome di un dominio esistente.
NextToken Stringa No Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
UpgradeHistoryList UpgradeHistoryList Container per log dei risultati delle ultime 10 operazioni di aggiornamento.

GetUpgradeStatus

Restituisce lo stato più recente dell'aggiornamento della versione OpenSearch o Elasticsearch di un dominio.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
DomainName DomainName Nome di un dominio esistente.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
UpgradeStepItem UpgradeStepItem Container per lo stato più recente dell'aggiornamento della versione di un dominio.

ListDomainNames

Visualizza i nomi di tutti i domini OpenSearch Service di proprietà dell'utente corrente nella regione attiva.

Sintassi

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

Parametri della richiesta

Campo Tipo di dati Obbligatorio? Descrizione
EngineType Stringa No Filtra l'output in base al tipo di motore di dominio. I valori accettabili sono Elasticsearch e OpenSearch.

Questa operazione non utilizza parametri richiesta.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
DomainNameList DomainNameList I nomi di tutti i domini OpenSearch Service di proprietà dell'utente corrente.

ListDomainsForPackage

Elenca tutti i domini OpenSearch Service a cui è associato un pacchetto.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
PackageID Stringa Il pacchetto per il quale elencare i domini.
MaxResults Numero intero No Limita il numero di risultati.
NextToken Stringa No Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
DomainPackageDetailsList Elenco Elenco di oggetti DomainPackageDetails
NextToken Stringa Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

ListVersions

Elenca tutte le versioni supportate di OpenSearch e Elasticsearch su OpenSearch Service.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
MaxResults Numero intero No Limita il numero di risultati. Deve essere un valore compreso tra 30 e 100.
NextToken Stringa No Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

ListInstanceTypeDetails

Elenca tutti i tipi di istanza e le caratteristiche disponibili per una determinata versione di OpenSearch o Elasticsearch

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
EngineVersion Stringa Versione di OpenSearch o Elasticsearch, nel formato Elasticsearch_X.Y o OpenSearch_x.y. Il valore di default è la versione più recente di OpenSearch. Per l'elenco completo delle versioni supportate, consulta Versioni supportate di OpenSearch ed Elasticsearch.
DomainName DomainName Nome del dominio per cui si desidera elencare i dettagli del tipo di istanza.

MaxResults

Numero intero

No

Limita il numero di risultati. Deve essere un valore compreso tra 30 e 100.
NextToken Stringa No Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
InstanceTypeDetails Elenco Elenca tutti i tipi di istanza e le funzionalità supportate per la versione OpenSearch o Elasticsearch specificata.
NextToken Stringa Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

ListPackagesForDomain

Elenca tutti i pacchetti associati al dominio OpenSearch Service.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
DomainName Stringa Il nome del dominio per il quale si desidera elencare i pacchetti associati.
MaxResults Numero intero No Limita il numero di risultati.
NextToken Stringa No Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
DomainPackageDetailsList List Elenco di oggetti DomainPackageDetails
NextToken String Usato per la paginazione. Necessario solo se una chiamata API precedente ha generato un risultato contenente NextToken. Accetta un input di token successivo per restituire i risultati per la pagina successiva e fornisce un output di token successivo nella risposta, che i client possono usare per recuperare più risultati.

ListTags

Visualizza tutti i tag di risorse per un dominio OpenSearch Service.

Sintassi

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

Parametri della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
ARN ARN Il nome della risorsa Amazon (ARN) del dominio OpenSearch Service.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
TagList TagList Elenco dei tag delle risorse. Per ulteriori informazioni, consultare Assegnazione di tag dei domini Amazon OpenSearch Service.

PurchaseReservedInstanceOffering

Acquista un'istanza riservata.

Sintassi

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

Parametri della richiesta

Questa operazione non usa parametri della richiesta HTTP.

Corpo della richiesta

Nome Tipo di dati Obbligatorio? Descrizione
ReservationName Stringa Nome descrittivo per la prenotazione. Devono contenere da 5 a 64 caratteri.
ReservedInstanceOfferingId Stringa ID dell'offerta.
InstanceCount Numero intero Numero di istanze da riservare.

Elementi della risposta

Campo Tipo di dati Descrizione
ReservationName Stringa Nome della prenotazione.
ReservedInstanceId Stringa ID della prenotazione.

RejectInboundConnection

Consente al proprietario del dominio di destinazione di rifiutare una richiesta di connessione di ricerca tra cluster in ingresso.

Sintassi

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

Parametri della richiesta

Questa operazione non usa parametri della richiesta HTTP.

Corpo della richiesta

Questa operazione non usa il corpo della richiesta HTTP.

Elementi della risposta

Campo Tipo di dati Descrizione
CrossClusterSearchConnection Oggetto Dettagli della connessione in ingresso.

RemoveTags

Rimuove i tag di risorsa specificati da un dominio OpenSearch Service.

Sintassi

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" ] }

Parametri della richiesta

Questa operazione non usa parametri della richiesta HTTP.

Corpo della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
ARN ARN Il nome della risorsa Amazon (ARN) di un dominio OpenSearch Service. Per ulteriori informazioni, consultare Identificatori IAM nella Guida per l'utente di AWS Identity and Access Management.
TagKeys TagKey Elenco delle chiavi tag per i tag risorsa da rimuovere da un dominio del servizio OpenSearch.

Elementi della risposta

L'operazione RemoveTags non restituisce un elemento della risposta.

StartServiceSoftwareUpdate

Pianifica un aggiornamento del software di servizio per un dominio OpenSearch Service.

Sintassi

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

Parametri della richiesta

Questa operazione non usa parametri della richiesta HTTP.

Corpo della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
DomainName DomainName Nome del dominio OpenSearch Service per cui si desidera aggiornare il software di servizio più recente.

Elementi della risposta

Campo Tipo di dati Descrizione
ServiceSoftwareOptions ServiceSoftwareOptions Container per lo stato del dominio relativo al software del servizio più recente.

CancelServiceSoftwareUpdate

Pianifica un aggiornamento del software di servizio pianificato per un dominio OpenSearch Service. Funziona solo se UpdateStatus del dominio è PENDING_UPDATE.

Sintassi

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

Parametri della richiesta

Questa operazione non usa parametri della richiesta HTTP.

Corpo della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
DomainName DomainName Nome del dominio OpenSearch Service per cui si desidera aggiornare il software di servizio più recente.

Elementi della risposta

Campo Tipo di dati Descrizione
ServiceSoftwareOptions ServiceSoftwareOptions Container per lo stato del dominio relativo al software del servizio più recente.

UpdateDomainConfig

Modifica la configurazione di un dominio OpenSearch Service, come il tipo di istanza e il numero di istanze. È necessario specificare solo i valori che desideri aggiornare.

Sintassi

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 }

Parametri della richiesta

Questa operazione non usa parametri della richiesta HTTP.

Corpo della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
DomainName DomainName Nome del dominio OpenSearch Service per cui si desidera aggiornare la configurazione.
ClusterConfig ClusterConfig No Modifiche desiderate per la configurazione del cluster, ad esempio il tipo di istanza e il numero di istanze EC2.
EBSOptions EBSOptions No Tipo e dimensioni dei volumi EBS collegati ai nodi di dati.
VPCOptions VPCOptions No Container per i valori necessari per configurare OpenSearch Service per l'uso con un VPC. Per ulteriori informazioni, consultare Avvio dei domini Amazon OpenSearch Service all'interno di un VPC.
SnapshotOptions SnapshotOptions No OBSOLETA. Ora in cui il servizio acquisisce uno snapshot giornaliero automatico degli indici nel dominio OpenSearch Service.
AdvancedOptions AdvancedOptions No Coppie chiave-valore per specificare le opzioni di configurazione avanzate. Per ulteriori informazioni, consultare Impostazioni avanzate del cluster.
AccessPolicies Stringa No Specifica le policy di accesso per il dominio OpenSearch Service. Per ulteriori informazioni, consultare Configurazione delle policy di accesso.
LogPublishingOptions LogPublishingOptions No Coppie di stringhe chiave-valore per configurare la pubblicazione di log lenti.
CognitoOptions CognitoOptions No Coppie chiave-valore per configurare OpenSearch Service per l'uso dell'autenticazione Amazon Cognito per OpenSearch Dashboards.
DomainEndpointOptions DomainEndpointOptions No Opzioni aggiuntive per l'endpoint del dominio, ad esempio la possibilità di richiedere il protocollo HTTPS per tutto il traffico.
AdvancedSecurityOptions AdvancedSecurityOptions No Opzioni per il controllo granulare degli accessi.
AutoTuneOptions Opzioni AutoTune No Opzioni per la regolazione automatica.
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions No Abilita la crittografia da nodo a nodo.
EncryptionAtRestOptions EncryptionAtRestOptions No Coppie chiave-valore per abilitare la crittografia dei dati a riposo.
DryRun Boolean No L'impostazione predefinita è false. Se true, OpenSearch Service verifica se la modifica della configurazione causerà una implementazione blu/verde, ma non esegue l'aggiornamento.

Elementi della risposta

Campo Tipo di dati
DomainConfig Configurazione dominio
DryRunResults Risultati Dry Run

Aggiorna il pacchetto

Aggiornare un pacchetto da utilizzare con i domini OpenSearch Service.

Sintassi

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" } }

Parametri della richiesta

Questa operazione non utilizza parametri richiesta.

Corpo della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
PackageID Stringa ID univoco del pacchetto.
PackageDescription Stringa No Descrizione del pacchetto.
CommitMessage Stringa No Messaggio di commit per il file aggiornato.
PackageSource PackageSource Bucket S3 e chiave per il pacchetto.

Elementi della risposta

Campo Tipo di dati
PackageDetails PackageDetails

UpgradeDomain

Aggiorna un dominio Amazon OpenSearch Service a una versione più recente di OpenSearch o Elasticsearch. In alternativa, controlla idoneità aggiornamento.

Sintassi

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

Parametri della richiesta

Questa operazione non usa parametri della richiesta HTTP.

Corpo della richiesta

Parametro Tipo di dati Obbligatorio? Descrizione
DomainName Stringa Nome del dominio OpenSearch Service che si desidera aggiornare.
TargetVersion Stringa Versione di OpenSearch o Elasticsearch a cui si desidera eseguire l'aggiornamento, nel formato Opensearch_X.Y o Elasticsearch_X.Y. Consultare GetCompatibleVersions.
PerformCheckOnly Boolean No L'impostazione predefinita è false. Se true, OpenSearch Service controlla l'idoneità del dominio, ma non esegue l'aggiornamento.

AdvancedOptions

AdvancedOptions No Supporta solo il parametro override_main_response_version e non altre opzioni avanzate. È possibile includere questa opzione solo quando si esegue l'aggiornamento a una versione di OpenSearch. Specifica se il dominio segnala la sua versione come 7.10 in modo che continui a funzionare con client e plug-in Elasticsearch OSS.

Elementi della risposta

Campo Tipo di dati Descrizione
UpgradeDomainResponse Eseguire la mappatura Dettagli dell'operazione di conferma della risposta base.

Tipi di dati

Questa sezione descrive i tipi di dati usati dall'API di configurazione.

AdvancedOptions

Coppie chiave-valore per specificare le opzioni di configurazione avanzate di OpenSearch.

Campo Tipo di dati Descrizione
rest.action.multi.allow_explicit_index Coppia chiave-valore:

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

Nota l'uso di una stringa piuttosto che di un booleano. Specifica se i riferimenti espliciti agli indici sono permessi all'interno del corpo delle richieste HTTP. Se desideri configurare policy d'accesso per le risorse secondarie del dominio, ad esempio indici e API di dominio specifici, devi disabilitare questa proprietà. Per ulteriori informazioni sulle policy di accesso per le risorse secondarie, consultare Configurazione delle policy di accesso.
indices.fielddata.cache.size Coppia chiave-valore:

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

Si noti l'uso di una stringa piuttosto che di un numero intero. Specifica la percentuale di spazio heap Java allocata ai dati del campo. Per impostazione predefinita, questa impostazione è illimitata.
indices.query.bool.max_clause_count Coppia chiave-valore:

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

Si noti l'uso di una stringa piuttosto che di un numero intero. Specifica il numero massimo di clausole permesse in una query booleana Lucene. Il valore di default è 1.024. Le query con un numero di clausole superiore a quello permesso generano un errore TooManyClauses. Per ulteriori informazioni, consultare la documentazione di Lucene.
override_main_response_version Coppia chiave-valore:

"override_main_response_version":"true"

Nota l'uso di una stringa piuttosto che di un booleano. Specifica se il dominio segnala la sua versione come 7.10 per consentire a client e plug-in Elasticsearch OSS di continuare a lavorare con esso. Rilevante solo quando si crea un dominio OpenSearch o si esegue l'aggiornamento a OpenSearch da una versione di Elasticsearch OSS. Il valore di default è false durante la creazione di un dominio e true durante l'aggiornamento di un dominio.

AdvancedSecurityOptions

Campo Tipo di dati Descrizione
Enabled Boolean True per abilitare il controllo granulare degli accessi .
AnonymousAuthEnabled Boolean True per abilitare un periodo di migrazione di 30 giorni durante il quale gli amministratori possono creare mappature dei ruoli. Unico necessario abilitazione del controllo dettagliato degli accessi su un dominio esistente.
AnonymousAuthDisableDate Time stamp Data e ora di disattivazione del periodo di migrazione.
InternalUserDatabaseEnabled Boolean True per abilitare il database utente interno.
MasterUserOptions MasterUserOptions Contenitore per informazioni sull'utente master.
SAMLOptions SAMLOptions Container per informazioni sulla configurazione SAML per OpenSearch Dashboards.

ARN

Campo Tipo di dati Descrizione
ARN Stringa Il nome della risorsa Amazon (ARN) di un dominio OpenSearch Service. Per ulteriori informazioni, consultare ARN IAM nella Guida per l'utente di AWS Identity and Access Management.

Opzioni AutoTune

Campo Tipo di dati Descrizione
DesiredState Stringa ENABLED o DISABLED.
MaintenanceSchedules Elenco

Un elenco delle pianificazioni di manutenzione durante le quali la regolazione automatica può implementare le modifiche:

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

Le pianificazioni di manutenzione vengono sovrascritte, non aggiunte. Se la richiesta non include pianificazioni, la richiesta elimina tutte le pianificazioni esistenti. Per mantenere le pianificazioni esistenti, per prima cosa effettuare una chiamata a DescribeDomainConfig e usare la parte MaintenanceSchedulesdella risposta come base per questa sezione.

StartAt è l'ora Epoch e Value è un numero intero lungo.

RollbackOnDisable Stringa Quando disabiliti la regolazione automatica, specifica NO_ROLLBACK per mantenere tutte le impostazioni di regolazione automatica precedenti o DEFAULT_ROLLBACK per ripristinare le impostazioni predefinite del servizio OpenSearch.

Se si specifica DEFAULT_ROLLBACK, è necessario includere una MaintenanceSchedule nella richiesta. In caso contrario, OpenSearch Service non sarà in grado di eseguire il ripristino dello stato precedente.

Modifica dei dettagli sullo stato di avanzamento

Container per informazioni su una modifica della configurazione in corso su un dominio.

Campo Tipo di dati Descrizione
ChangeId Stringa L'ID della modifica della configurazione.
Message Stringa Un messaggio corrispondente allo stato della modifica della configurazione.

Modifica dello stato di avanzamento

Container per informazioni sulle fasi di una modifica della configurazione in corso su un dominio.

Campo Tipo di dati Descrizione
ChangeId Stringa ID della modifica della configurazione.
ChangeProgressStages Oggetto Dettagli sullo stato di avanzamento per ogni fase del processo di aggiornamento. Ciascuna fase include un campo Description, LastUpdated, Name, e Status.
CompletedProperties StringList Elenco delle proprietà del dominio che sono già state aggiornate.
PendingProperties StringList Elenco delle proprietà del dominio che devono ancora essere aggiornate.
StartTime Time stamp Data e ora di avvio della modifica della configurazione.
Status Stringa Lo stato corrente della modifica della configurazione.
TotalNumberOfStages Numero intero Numero totale di fasi necessarie per il completamento della modifica della configurazione.

ClusterConfig

Container per la configurazione cluster di un dominio OpenSearch Service.

Campo Tipo di dati Descrizione
InstanceType Stringa Tipo di istanza dei nodi di dati nel cluster.
InstanceCount Numero intero Numero di istanze nel cluster.
DedicatedMasterEnabled Boolean Indica se i nodi master dedicati sono abilitati per il cluster. True se il cluster utilizzerà un nodo master dedicato. False in caso contrario. Per ulteriori informazioni, consultare Nodi principali dedicati in Amazon OpenSearch Service.
DedicatedMasterType Stringa Tipo di istanza di OpenSearch Service dei nodi principali dedicati nel cluster.
DedicatedMasterCount Numero intero Numero di nodi master dedicati nel cluster. Questo numero deve essere maggiore di 1, altrimenti verrà ricevuta un'eccezione di convalida.
ZoneAwarenessEnabled Boolean Indica se sono abilitate più zone di disponibilità. Per ulteriori informazioni, consultare Configurazione di un dominio multi-AZ in Amazon OpenSearch Service.
ZoneAwarenessConfig ZoneAwarenessConfig Container per le opzioni di configurazione di riconoscimento zone. Richiesto solo se ZoneAwarenessEnabled è true.
WarmEnabled Boolean Indica se abilitare l'archiviazione a caldo per il cluster.
WarmCount Numero intero Il numero di nodi a caldo nel cluster.
WarmType Stringa Tipo di istanza per i nodi a caldo del cluster.
WarmStorage Numero intero La quantità totale di archiviazione a caldo fornita in GiB.
ColdStorageOptions ColdStorageOptions Container per le opzioni di configurazione di archiviazione a freddo.

CognitoOptions

Campo Tipo di dati Descrizione
Enabled Boolean Indica se abilitare o disabilitare l'autenticazione Amazon Cognito per OpenSearch Dashboards. Per informazioni, consultare Configurazione dell'autenticazione Amazon Cognito per OpenSearch Dashboards.
UserPoolId Stringa L'ID del bacino d'utenza di Amazon Cognito che si desidera venga usato per l'autenticazione di OpenSearch Dashboards.
IdentityPoolId Stringa L'ID del pool di identità di Amazon Cognito che si desidera venga usato per l'autenticazione di OpenSearch Dashboards.
RoleArn Stringa Il ruolo AmazonOpenSearchServiceCognitoAccess che consente a OpenSearch Service di configurare il bacino d'utenza e il pool di identità.

Opzioni di ColdStorage

Container per i parametri necessari per abilitare l'archiviazione a freddo per un dominio OpenSearch Service.

Campo Tipo di dati Descrizione
Enabled Boolean Indica se abilitare o disabilitare l'archiviazione a freddo nel dominio. Per informazioni, consultare Archiviazione a freddo per Amazon OpenSearch Service.

Crea richiesta dominio

Container per i parametri richiesti dall'operazione del servizio CreateDomain.

Campo Tipo di dati Descrizione
DomainName DomainName Nome del dominio OpenSearch Service da creare.
ClusterConfig ClusterConfig Container per la configurazione cluster di un dominio OpenSearch Service.
EBSOptions EBSOptions Container per i parametri necessari per abilitare l'archiviazione basata su EBS per un dominio OpenSearch Service.
AccessPolicies Stringa Documento di policy IAM che specifica le policy di accesso per il nuovo dominio OpenSearch Service. Per ulteriori informazioni, consultare Configurazione delle policy di accesso.
DomainEndpointOptions DomainEndpointOptions Opzioni aggiuntive per l'endpoint del dominio, ad esempio la possibilità di richiedere il protocollo HTTPS per tutto il traffico.
SnapshotOptions SnapshotOptions OBSOLETA. Container per i parametri necessari per configurare gli snapshot automatici degli indici di dominio.
VPCOptions VPCOptions Container per i valori necessari per configurare OpenSearch Service per l'uso con un VPC.
LogPublishingOptions LogPublishingOptions Coppie di stringhe chiave-valore per configurare la pubblicazione di log lenti.
AdvancedOptions AdvancedOptions Coppie chiave-valore per specificare le opzioni di configurazione avanzate.
CognitoOptions CognitoOptions Coppie chiave-valore per configurare OpenSearch Service per l'uso dell'autenticazione Amazon Cognito per OpenSearch Dashboards.
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions Specifica true per abilitare la crittografia da nodo a nodo.

DomainEndpointOptions

Campo Tipo di dati Descrizione
EnforceHTTPS Boolean true per richiedere che tutto il traffico verso il dominio arrivi su HTTPS.
TLSSecurityPolicy Stringa La versione TLS minima richiesta per il traffico verso il dominio. I valori validi sono TLS 1.0 (predefinito) o 1.2:
  • Policy-Min-TLS-1-0-2019-07

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

CustomEndpointEnabled Boolean Indica se abilitare un endpoint personalizzato per il dominio.
CustomEndpoint Stringa L'URL completo per l'endpoint personalizzato.
CustomEndpointCertificateArn Stringa L'ARN per il certificato di sicurezza, gestito in ACM.

DomainID

Tipo di dati Descrizione
Stringa Identificatore univoco per un dominio OpenSearch Service.

DomainName

Nomi di un dominio OpenSearch Service.

Tipo di dati Descrizione
Stringa Nomi di un dominio OpenSearch Service. I nomi di dominio sono univoci tra tutti i domini di proprietà dello stesso account all'interno di una Regione AWS. I nomi di dominio devono iniziare con una lettera minuscola e devono includere da 3 a 28 caratteri. I caratteri validi sono a-z (solo caratteri minuscoli), 0–9 e – (trattino).

DomainNameList

Stringa di nomi di dominio OpenSearch Service.

Tipo di dati Descrizione
Matrice di stringhe Array di domini OpenSearch Service nel formato seguente:

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

DomainPackageDetails

Informazioni su un pacchetto associato a un dominio.

Campo Tipo di dati Descrizione
DomainName Stringa Nome del dominio a cui è stato associato un pacchetto.
DomainPackageStatus Stringa Stato dell'associazione. I valori sono ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING e DISSOCIATION_FAILED.
ErrorDetails Stringa Ulteriori informazioni se il pacchetto è in stato di errore. Null altrimenti.
LastUpdated Time stamp Timestamp dell'aggiornamento più recente allo stato dell'associazione.
PackageID Stringa ID interno del pacchetto.
PackageName Stringa Nome del pacchetto specificato dall'utente.
PackageType Stringa Al momento, supporta solo TXT-DICTIONARY.
ReferencePath Stringa Denota la posizione del pacchetto sui nodi del cluster OpenSearch Service. È lo stesso synonym_path dei file del dizionario.

Configurazione dominio

Container per la configurazione di un dominio OpenSearch Service.

Campo Tipo di dati Descrizione
EngineVersion Stringa Versione di OpenSearch o Elasticsearch.
ClusterConfig ClusterConfig Container per la configurazione cluster di un dominio OpenSearch Service.
EBSOptions EBSOptions Container per le opzioni EBS configurate per un dominio OpenSearch Service.
AccessPolicies Stringa Specifica le policy di accesso per il dominio OpenSearch Service. Per ulteriori informazioni, consultare Configurazione delle policy di accesso.
SnapshotOptions SnapshotOptions OBSOLETA. Container per i parametri necessari per configurare gli snapshot automatici degli indici di dominio.
DomainEndpointOptions DomainEndpointOptions Opzioni aggiuntive per l'endpoint del dominio, ad esempio la possibilità di richiedere il protocollo HTTPS per tutto il traffico.
VPCOptions VPCDerivedInfo Attuale valore VPCOptions per il dominio e stato degli aggiornamenti alla configurazione.
LogPublishingOptions LogPublishingOptions Coppie chiave-valore per configurare la pubblicazione di log lenti.
AdvancedOptions AdvancedOptions Coppie chiave-valore per specificare le opzioni di configurazione avanzate.
EncryptionAtRestOptions EncryptionAtRestOptions Coppie chiave-valore per abilitare la crittografia dei dati a riposo.
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions A prescindere che la crittografia da nodo a nodo sia abilitata o disabilitata.
ChangeProgressDetails ChangeProgressDetails Container per informazioni sull'avanzamento della modifica della configurazione.

DomainStatus

Container per i contenuti di una struttura di dati DomainStatus.

Campo Tipo di dati Descrizione
DomainID DomainID Identificatore univoco per un dominio OpenSearch Service.
DomainName DomainName Nomi di un dominio OpenSearch Service. I nomi di dominio sono univoci tra tutti i domini di proprietà dello stesso account all'interno di una Regione AWS. I nomi di dominio devono iniziare con una lettera minuscola e devono includere da 3 a 28 caratteri. I caratteri validi sono a-z (solo caratteri minuscoli), 0–9 e – (trattino).
ARN ARN Il nome della risorsa Amazon (ARN) di un dominio OpenSearch Service. Per ulteriori informazioni, consultare Identificatori IAM nella Guida per l'utente di AWS Identity and Access Management.
Created Boolean Stato di creazione di un dominio OpenSearch Service. True se la creazione del dominio è completa, False se la creazione del dominio è ancora in corso.
Deleted Boolean Stato di eliminazione di un dominio OpenSearch Service. True se l'eliminazione del dominio è completa, False se l'eliminazione del dominio è ancora in corso.
Endpoint ServiceUrl Endpoint specifico del dominio utilizzato per inviare richieste di indice, ricerca e caricamento dati a un dominio OpenSearch Service.
Endpoints EndpointsMap La coppia chiave-valore esistente se il dominio OpenSearch Service usa endpoint VPC.
Processing Boolean Stato di una modifica nella configurazione di un dominio OpenSearch Service. True se il servizio sta ancora elaborando modifiche di configurazione, False se la modifica di configurazione è attiva. È necessario attendere che un dominio raggiunga lo stato attivo prima di inviare richieste di indice, ricerca e caricamento dati.
EngineVersion Stringa Versione di OpenSearch o Elasticsearch.
ClusterConfig ClusterConfig Container per la configurazione cluster di un dominio OpenSearch Service.
EBSOptions EBSOptions Container per i parametri necessari per abilitare l'archiviazione basata su EBS per un dominio OpenSearch Service.
AccessPolicies Stringa Documento di policy IAM che specifica le policy di accesso per il nuovo dominio OpenSearch Service. Per ulteriori informazioni, consultare Configurazione delle policy di accesso.
SnapshotOptions SnapshotOptions OBSOLETA. Container per i parametri richiesti per configurare l'ora degli snapshot automatici giornalieri di indici del dominio OpenSearch Service.
VPCOptions VPCDerivedInfo Informazioni derivate da OpenSearch Service in base a VPCOptions per il dominio.
LogPublishingOptions LogPublishingOptions Coppie chiave-valore per configurare la pubblicazione di log lenti.
AdvancedOptions AdvancedOptions Coppie chiave-valore per specificare le opzioni di configurazione avanzate.
EncryptionAtRestOptions EncryptionAtRestOptions Coppie chiave-valore per abilitare la crittografia dei dati a riposo.
CognitoOptions CognitoOptions Coppie chiave-valore per configurare OpenSearch Service per l'uso dell'autenticazione Amazon Cognito per OpenSearch Dashboards.
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions A prescindere che la crittografia da nodo a nodo sia abilitata o disabilitata.
UpgradeProcessing Boolean True se è in corso un aggiornamento a una nuova versione di OpenSearch o Elasticsearch.
ServiceSoftwareOptions ServiceSoftwareOptions Lo stato del software di servizio del dominio.

DomainStatusList

Elenco che contiene lo stato di ogni dominio OpenSearch Service specificato.

Campo Tipo di dati Descrizione
DomainStatusList DomainStatus Elenco che contiene lo stato di ogni dominio OpenSearch Service specificato.

Risultati Dry Run

Risultati di un test eseguito in una richiesta di aggiornamento del dominio.

Campo Tipo di dati Descrizione
DeploymentType Stringa I risultati di un test eseguito in una operazione UpdateDomainConfig. Descrive il tipo di implementazione causata dall'aggiornamento. Uno dei quattro valori:
  • Blu/verde

  • DynamicUpdate

  • Indeterminato

  • Nessuno

Message Stringa

Un messaggio corrispondente al tipo di implementazione.

EBSOptions

Container per i parametri necessari per abilitare l'archiviazione basata su EBS per un dominio OpenSearch Service.

Campo Tipo di dati Descrizione
EBSEnabled Boolean Indica se i volumi EBS sono collegati ai nodi di dati in un dominio OpenSearch Service.
VolumeType Stringa Specifica il tipo di volumi EBS collegati ai nodi di dati. Le opzioni sono gp3, gp2, io1 e standard (magnetico).
VolumeSize Stringa Specifica la dimensione (in GiB) dei volumi EBS collegati ai nodi di dati.
Iops Stringa Specifica le prestazioni di input/output (I/O) di base dei volumi EBS collegati ai nodi di dati. Applicabile solo per gp3 e il tipo di volume EBS con capacità di IOPS allocata.
Throughput Stringa Specifica la velocità di trasmissione effettiva (in MiB/s) dei volumi EBS collegati ai nodi di dati. Applicabile solo al tipo di volume gp3.

EncryptionAtRestOptions

Specifica se il dominio deve crittografare i dati a riposo e, in caso affermativo, la chiave AWS Key Management Service (KMS) da utilizzare. Può essere utilizzato solo per creare un nuovo dominio, non aggiornarne uno esistente. Per ulteriori informazioni, consultare Abilitazione della crittografia dei dati a riposo.

Campo Tipo di dati Descrizione
Enabled Boolean Specifica true per abilitare la crittografia dei dati a riposo.
KmsKeyId Stringa ID della chiave KMS. Utilizza il modulo 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

EndpointsMap

La coppia chiave-valore che contiene l'endpoint VPC. Esiste solo se il dominio OpenSearch Service si trova in un VPC.

Campo Tipo di dati Descrizione
Endpoints Coppia stringa chiave-valore: "vpc": "<VPC_ENDPOINT>" L'endpoint VPC per il dominio.

Filters

Filtra i pacchetti inclusi in una risposta DescribePackages.

Campo Tipo di dati Descrizione
Name Stringa Qualsiasi campo da PackageDetails.
Value Elenco Un elenco di valori per il campo specificato.

LogPublishingOptions

Specifica se il dominio OpenSearch Service pubblica l'applicazione OpenSearch e i log lenti su Amazon CloudWatch. È ancora necessario abilitare la raccolta dei log lenti usando l'API REST di OpenSearch. Per ulteriori informazioni, consultare Impostazione delle soglie di registrazione di OpenSearch per i log lenti.

Campo Tipo di dati Descrizione
INDEX_SLOW_LOGS Chiave-valore

Due coppie chiave-valore che definiscono il gruppo di log CloudWatch e se il log lento dell'indice OpenSearch deve essere pubblicato:

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

Due coppie chiave-valore che definiscono il gruppo di log CloudWatch e se il log lento della ricerca OpenSearch deve essere pubblicato:

"CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group:sample-domain", "Enabled":true
ES_APPLICATION_LOGS Chiave-valore Due coppie chiave-valore che definiscono il gruppo di log CloudWatch e se il log lento di errori OpenSearch deve essere pubblicato:
"CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group:sample-domain", "Enabled":true

MasterUserOptions

Campo Tipo di dati Descrizione
MasterUserARN Stringa ARN per l'utente master. Specificare solo se InternalUserDatabaseEnabled è false in AdvancedSecurityOptions.
MasterUserName Stringa Nome utente dell'utente master. Specificare solo se InternalUserDatabaseEnabled è true in AdvancedSecurityOptions.
MasterUserPassword Stringa Password dell'utente master. Specificare solo se InternalUserDatabaseEnabled è true in AdvancedSecurityOptions.

NodeToNodeEncryptionOptions

Abilita o disabilita la crittografia da nodo a nodo.

Campo Tipo di dati Descrizione
Enabled Boolean Abilita con true.

OptionState

Stato di un aggiornamento alle opzioni avanzate per un dominio OpenSearch Service.

Campo Tipo di dati Descrizione
OptionStatus Stringa Uno di tre valori validi:
  • RequiresIndexDocuments

  • Elaborazione

  • Attivo

OptionStatus

Stato di un aggiornamento delle opzioni di configurazione per un dominio OpenSearch Service.

Campo Tipo di dati Descrizione
CreationDate Time stamp Data e ora di creazione del dominio OpenSearch Service.
UpdateDate Time stamp Data e ora di aggiornamento del dominio OpenSearch Service.
UpdateVersion Numero intero Numero intero che specifica la versione più recente per l'entità.
State OptionState Stato di un aggiornamento delle opzioni di configurazione per un dominio OpenSearch Service.
PendingDeletion Boolean Indica se il servizio sta elaborando una richiesta per eliminare definitivamente il dominio OpenSearch Service e tutte le sue risorse.

PackageDetails

Informazioni di base su un pacchetto.

Campo Tipo di dati Descrizione
CreatedAt Time stamp L'ora di creazione del pacchetto.
ErrorDetails Stringa Ulteriori informazioni se il pacchetto è in stato di errore. Null altrimenti.
PackageDescription Stringa Descrizione del pacchetto specificata dall'utente.
PackageID Stringa ID interno del pacchetto.
PackageName Stringa Nome del pacchetto specificato dall'utente.
PackageStatus Stringa I valori sono COPYING, COPY_FAILED, AVAILABLE, DELETING o DELETE_FAILED .
PackageType Stringa Al momento, supporta solo TXT-DICTIONARY.

PackageSource

Bucket e chiave per il pacchetto che si desidera aggiungere a OpenSearch Service.

Campo Tipo di dati Descrizione
S3BucketName Stringa Il nome del bucket contenente il pacchetto.
S3Key Stringa Chiave (nome file) del pacchetto.

SAMLOptions

Campo Tipo di dati Descrizione
Enabled Boolean Indica se abilitare l'autenticazione SAML per OpenSearch Dashboards.
MasterUserName Stringa Questo nome utente dall'IdP SAML riceve autorizzazioni complete per il cluster, equivalenti a quelle di un nuovo utente principale.
MasterBackendRole Stringa Questo ruolo di back-end dall'IdP SAML riceve autorizzazioni complete per il cluster, equivalenti a quelle di un nuovo utente principale.
Idp Oggetto

Container per le informazioni dal provider di identità. Contiene due elementi:

"Idp": { "EntityId": "entity-id", "MetadataContent": "metadata-content-with-quotes-escaped" }
RolesKey Stringa Elemento dell'asserzione SAML da utilizzare per i ruoli di back-end. Il valore predefinito è roles.
SubjectKey Stringa Elemento dell'asserzione SAML da utilizzare per il nome utente. Il valore predefinito è NameID.
SessionTimeoutMinutes Numero intero Durata di una sessione in minuti dopo che un utente effettua l'accesso. Il valore di default è 60. Il valore massimo è 1.440 (24 ore).

ServiceSoftwareOptions

Container per lo stato del dominio relativo al software del servizio più recente.

Campo Tipo di dati Descrizione
UpdateAvailable Boolean Se un aggiornamento del software del servizio è disponibile per il dominio.
Cancellable Boolean Se hai richiesto un aggiornamento del dominio, a prescindere che sia possibile annullare l'aggiornamento.
AutomatedUpdateDate Time stamp L'ora in formato Epoch di chiusura della finestra di distribuzione degli aggiornamenti necessari. Dopo questo tempo, OpenSearch Service pianifica l'aggiornamento del software automaticamente.
UpdateStatus Stringa Lo stato dell'aggiornamento. I valori sono ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED e NOT_ELIGIBLE.
Description Stringa Una descrizione più dettagliata dello stato.
CurrentVersion Stringa La versione corrente del software del servizio.
NewVersion Stringa La versione più recente del software del servizio.
OptionalDeployment Boolean Indica se l'aggiornamento del software del servizio è opzionale.

ServiceURL

Endpoint specifico del dominio utilizzato per inviare richieste di indice, ricerca e caricamento dati a un dominio OpenSearch Service.

Campo Tipo di dati Descrizione
ServiceURL Stringa Endpoint specifico del dominio utilizzato per inviare richieste di indice, ricerca e caricamento dati a un dominio OpenSearch Service.

SnapshotOptions

OBSOLETA. Per informazioni, consultare Creazione di snapshot di indici in Amazon OpenSearch Service. Container per i parametri richiesti per configurare l'ora degli snapshot automatici giornalieri degli indici in un dominio OpenSearch Service.

Campo Tipo di dati Descrizione
AutomatedSnapshotStartHour Numero intero OBSOLETA. Ora in cui il servizio acquisisce uno snapshot giornaliero automatico degli indici nel dominio OpenSearch Service.

Tag

Campo Tipo di dati Descrizione
Key TagKey Nome obbligatorio del tag. Le chiavi tag devono essere univoche per il dominio OpenSearch Service a cui sono collegate. Per ulteriori informazioni, consultare Assegnazione di tag dei domini Amazon OpenSearch Service.
Value TagValue Valore stringa opzionale del tag. I valori dei tag possono essere null e non devono necessariamente essere univoci in un set di tag. Ad esempio, può esserci una coppia chiave-valore in un set di tag project/Trinity e in cost-center/Trinity.

TagKey

Campo Tipo di dati Descrizione
Key Stringa Nome del tag. La stringa può contenere fino a 128 caratteri.

TagList

Campo Tipo di dati Descrizione
Tag Tag Tag di risorsa collegato a un dominio OpenSearch Service.

TagValue

Campo Tipo di dati Descrizione
Value Stringa Contiene il valore di un oggetto TagKey. La stringa può contenere fino a 256 caratteri.

VPCDerivedInfo

Campo Tipo di dati Descrizione
VPCId Stringa L'ID per il VPC. Amazon VPC genera questo valore quando si crea un VPC.
SubnetIds StringList Elenco di ID di sottoreti associati agli endpoint VPC per il dominio. Per ulteriori informazioni, consultare VPC e sottoreti nella Guida per l'utente di Amazon VPC.
AvailabilityZones StringList Elenco delle zone di disponibilità associate alle sottoreti VPC. Per ulteriori informazioni, consultare Informazioni di base su VPC e sottoreti nella Guida per l'utente di Amazon VPC.
SecurityGroupIds StringList Elenco di ID di gruppi di sicurezza associati agli endpoint VPC per il dominio. Per ulteriori informazioni, consultare Gruppi di sicurezza per il VPC nella Guida per l'utente di Amazon VPC.

VPCOptions

Campo Tipo di dati Descrizione
SubnetIds StringList Elenco di ID di sottoreti associati agli endpoint VPC per il dominio. Se il dominio utilizza più zone di disponibilità, è necessario fornire due ID sottorete, uno per ogni zona. In caso contrario, fornirne uno. Per ulteriori informazioni, consultare VPC e sottoreti nella Guida per l'utente di Amazon VPC.
SecurityGroupIds StringList Elenco di ID di gruppi di sicurezza associati agli endpoint VPC per il dominio. Se non si specifica un ID del gruppo di sicurezza, OpenSearch Service usa il gruppo di sicurezza di default per il VPC. Per ulteriori informazioni, consultare Gruppi di sicurezza per il VPC nella Guida per l'utente di Amazon VPC.
VPCId Stringa ID per il VPC.

ZoneAwarenessConfig

Campo Tipo di dati Descrizione
AvailabilityZoneCount Numero intero Se hai attivato più zone di disponibilità (AZ), questo campo corrisponde al numero di zone che si desidera che il dominio utilizzi. I valori validi sono 2 e 3.

Errori

OpenSearch Service genera gli errori seguenti:

Eccezione Descrizione
BaseException Generata per tutti gli errori del servizio. Contiene il codice di stato HTTP dell'errore.
ValidationException Generata quando la richiesta HTTP contiene input non valido o quando l'input richiesto non è presente. Restituisce il codice di stato HTTP 400.
DisabledOperationException Generata quando il client tenta di eseguire un'operazione non supportata. Restituisce il codice di stato HTTP 409.
InternalException Generata quando si verifica un errore interno al servizio durante l'elaborazione di una richiesta. Restituisce il codice di stato HTTP 500.
InvalidTypeException Generata durante il tentativo di creazione o di accesso a una risorsa secondaria di un dominio OpenSearch Service non valida o non supportata. Restituisce il codice di stato HTTP 409.
LimitExceededException Generata durante il tentativo di creazione di più del numero e del tipo consentiti di risorse e risorse secondarie del dominio OpenSearch Service. Restituisce il codice di stato HTTP 409.
ResourceNotFoundException Generata in caso di accesso a o eliminazione di una risorsa che non esiste. Restituisce il codice di stato HTTP 400.
ResourceAlreadyExistsException Generata quando un client prova a creare una risorsa che esiste già in un dominio OpenSearch Service. Restituisce il codice di stato HTTP 400.