Get Application

opensearchservice_get_application

R Documentation

Check the configuration and status of an existing OpenSearch Application¶

Description¶

Check the configuration and status of an existing OpenSearch Application.

Usage¶

opensearchservice_get_application(id)

Arguments¶

id: [required] Unique identifier of the checked OpenSearch Application.

Value¶

A list with the following syntax:

list(
  id = "string",
  arn = "string",
  name = "string",
  endpoint = "string",
  status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"FAILED",
  iamIdentityCenterOptions = list(
    enabled = TRUE|FALSE,
    iamIdentityCenterInstanceArn = "string",
    iamRoleForIdentityCenterApplicationArn = "string",
    iamIdentityCenterApplicationArn = "string"
  ),
  dataSources = list(
    list(
      dataSourceArn = "string",
      dataSourceDescription = "string"
    )
  ),
  appConfigs = list(
    list(
      key = "opensearchDashboards.dashboardAdmin.users"|"opensearchDashboards.dashboardAdmin.groups",
      value = "string"
    )
  ),
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  lastUpdatedAt = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$get_application(
  id = "string"
)