Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1496640547.5 KB

Retrieves the configuration and status of an existing OpenSearch application.

get/2021-01-01/opensearch/application/{id}

Path parameters

idstring required

The unique identifier of the OpenSearch application to retrieve.

Response

Success

idstring

The unique identifier of the OpenSearch application.

arnstring

The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.

namestring

The name of the OpenSearch application.

endpointstring

The endpoint URL of the OpenSearch application.

status'CREATING' | 'UPDATING' | 'DELETING' | 'ACTIVE' | 'FAILED'

The current status of the OpenSearch application. Possible values: <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.

createdAtstring date-time

The timestamp when the OpenSearch application was created.

lastUpdatedAtstring date-time

The timestamp of the last update to the OpenSearch application.

kmsKeyArnstring

The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest.