GetApplicationCommand

Suggest an Edit

Check the configuration and status of an existing OpenSearch Application.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { OpenSearchClient, GetApplicationCommand } from "@aws-sdk/client-opensearch"; // ES Modules import
// const { OpenSearchClient, GetApplicationCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import
const client = new OpenSearchClient(config);
const input = { // GetApplicationRequest
  id: "STRING_VALUE", // required
};
const command = new GetApplicationCommand(input);
const response = await client.send(command);
// { // GetApplicationResponse
//   id: "STRING_VALUE",
//   arn: "STRING_VALUE",
//   name: "STRING_VALUE",
//   endpoint: "STRING_VALUE",
//   status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "FAILED",
//   iamIdentityCenterOptions: { // IamIdentityCenterOptions
//     enabled: true || false,
//     iamIdentityCenterInstanceArn: "STRING_VALUE",
//     iamRoleForIdentityCenterApplicationArn: "STRING_VALUE",
//     iamIdentityCenterApplicationArn: "STRING_VALUE",
//   },
//   dataSources: [ // DataSources
//     { // DataSource
//       dataSourceArn: "STRING_VALUE",
//       dataSourceDescription: "STRING_VALUE",
//     },
//   ],
//   appConfigs: [ // AppConfigs
//     { // AppConfig
//       key: "opensearchDashboards.dashboardAdmin.users" || "opensearchDashboards.dashboardAdmin.groups",
//       value: "STRING_VALUE",
//     },
//   ],
//   createdAt: new Date("TIMESTAMP"),
//   lastUpdatedAt: new Date("TIMESTAMP"),
// };

GetApplicationCommand Input

See GetApplicationCommandInput for more details

Parameter
Type
Description
id
Required
string | undefined

Unique identifier of the checked OpenSearch Application.

GetApplicationCommand Output

See GetApplicationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
appConfigs
AppConfig[] | undefined

App configurations of the checked OpenSearch Application.

arn
string | undefined

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities   in Using Amazon Web Services Identity and Access Management for more information.

createdAt
Date | undefined

Timestamp at which the checked OpenSearch Application was created.

dataSources
DataSource[] | undefined

Associated data sources to the checked OpenSearch Application.

endpoint
string | undefined

Endpoint URL of the checked OpenSearch Application.

iamIdentityCenterOptions
IamIdentityCenterOptions | undefined

IAM Identity Center settings for the checked OpenSearch Application.

id
string | undefined

Unique identifier of the checked OpenSearch Application.

lastUpdatedAt
Date | undefined

Timestamp at which the checked OpenSearch Application was last updated.

name
string | undefined

Name of the checked OpenSearch Application.

status
ApplicationStatus | undefined

Current status of the checked OpenSearch Application. Possible values are CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

Throws

Name
Fault
Details
AccessDeniedException
client

An error occurred because you don't have permissions to access the resource.

BaseException
client

An error occurred while processing the request.

DisabledOperationException
client

An error occured because the client wanted to access an unsupported operation.

InternalException
server

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException
client

An exception for accessing or deleting a resource that doesn't exist.

ValidationException
client

An exception for accessing or deleting a resource that doesn't exist.

OpenSearchServiceException
Base exception class for all service exceptions from OpenSearch service.