Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetIntegration

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

Request Syntax


{
   "integrationName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

integrationName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\.\-_/#A-Za-z0-9]+

Required: Yes

Response Syntax


{
   "integrationDetails": { ... },
   "integrationName": "string",
   "integrationStatus": "string",
   "integrationType": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

integrationDetails

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.

Type: IntegrationDetails object

Note: This object is a Union. Only one member of this object can be specified or returned.

integrationName

The name of the integration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\.\-_/#A-Za-z0-9]+

integrationStatus

The current status of this integration.

Type: String

Valid Values: PROVISIONING | ACTIVE | FAILED

integrationType

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

Type: String

Valid Values: OPENSEARCH

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterException

A parameter is specified incorrectly.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 400

ServiceUnavailableException

The service cannot complete the request.

HTTP Status Code: 500