GetIntegrationCommand

Suggest an Edit

Returns information about one integration between CloudWatch Logs and OpenSearch Service.

Example Syntax

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

import { CloudWatchLogsClient, GetIntegrationCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
// const { CloudWatchLogsClient, GetIntegrationCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
const client = new CloudWatchLogsClient(config);
const input = { // GetIntegrationRequest
  integrationName: "STRING_VALUE", // required
};
const command = new GetIntegrationCommand(input);
const response = await client.send(command);
// { // GetIntegrationResponse
//   integrationName: "STRING_VALUE",
//   integrationType: "OPENSEARCH",
//   integrationStatus: "PROVISIONING" || "ACTIVE" || "FAILED",
//   integrationDetails: { // IntegrationDetails Union: only one key present
//     openSearchIntegrationDetails: { // OpenSearchIntegrationDetails
//       dataSource: { // OpenSearchDataSource
//         dataSourceName: "STRING_VALUE",
//         status: { // OpenSearchResourceStatus
//           status: "ACTIVE" || "NOT_FOUND" || "ERROR",
//           statusMessage: "STRING_VALUE",
//         },
//       },
//       application: { // OpenSearchApplication
//         applicationEndpoint: "STRING_VALUE",
//         applicationArn: "STRING_VALUE",
//         applicationId: "STRING_VALUE",
//         status: {
//           status: "ACTIVE" || "NOT_FOUND" || "ERROR",
//           statusMessage: "STRING_VALUE",
//         },
//       },
//       collection: { // OpenSearchCollection
//         collectionEndpoint: "STRING_VALUE",
//         collectionArn: "STRING_VALUE",
//         status: {
//           status: "ACTIVE" || "NOT_FOUND" || "ERROR",
//           statusMessage: "STRING_VALUE",
//         },
//       },
//       workspace: { // OpenSearchWorkspace
//         workspaceId: "STRING_VALUE",
//         status: {
//           status: "ACTIVE" || "NOT_FOUND" || "ERROR",
//           statusMessage: "STRING_VALUE",
//         },
//       },
//       encryptionPolicy: { // OpenSearchEncryptionPolicy
//         policyName: "STRING_VALUE",
//         status: {
//           status: "ACTIVE" || "NOT_FOUND" || "ERROR",
//           statusMessage: "STRING_VALUE",
//         },
//       },
//       networkPolicy: { // OpenSearchNetworkPolicy
//         policyName: "STRING_VALUE",
//         status: "<OpenSearchResourceStatus>",
//       },
//       accessPolicy: { // OpenSearchDataAccessPolicy
//         policyName: "STRING_VALUE",
//         status: "<OpenSearchResourceStatus>",
//       },
//       lifecyclePolicy: { // OpenSearchLifecyclePolicy
//         policyName: "STRING_VALUE",
//         status: "<OpenSearchResourceStatus>",
//       },
//     },
//   },
// };

GetIntegrationCommand Input

See GetIntegrationCommandInput for more details

Parameter
Type
Description
integrationName
Required
string | undefined

The name of the integration that you want to find information about. To find the name of your integration, use ListIntegrations 

GetIntegrationCommand Output

See GetIntegrationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
integrationDetails
IntegrationDetails | undefined

A structure that contains information about the integration configuration. For an integration with OpenSearch Service, this includes information about OpenSearch Service resources such as the collection, the workspace, and policies.

integrationName
string | undefined

The name of the integration.

integrationStatus
IntegrationStatus | undefined

The current status of this integration.

integrationType
IntegrationType | undefined

The type of integration. Integrations with OpenSearch Service have the type OPENSEARCH.

Throws

Name
Fault
Details
InvalidParameterException
client

A parameter is specified incorrectly.

ResourceNotFoundException
client

The specified resource does not exist.

ServiceUnavailableException
server

The service cannot complete the request.

CloudWatchLogsServiceException
Base exception class for all service exceptions from CloudWatchLogs service.