ListIntegrations
Returns a list of integrations between CloudWatch Logs and other services in this account. Currently, only one integration can be created in an account, and this integration must be with OpenSearch Service.
Request Syntax
{
"integrationNamePrefix": "string",
"integrationStatus": "string",
"integrationType": "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.
- integrationNamePrefix
-
To limit the results to integrations that start with a certain name prefix, specify that name prefix here.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
[\.\-_/#A-Za-z0-9]+Required: No
- integrationStatus
-
To limit the results to integrations with a certain status, specify that status here.
Type: String
Valid Values:
PROVISIONING | ACTIVE | FAILEDRequired: No
- integrationType
-
To limit the results to integrations of a certain type, specify that type here.
Type: String
Valid Values:
OPENSEARCHRequired: No
Response Syntax
{
"integrationSummaries": [
{
"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.
- integrationSummaries
-
An array, where each object in the array contains information about one CloudWatch Logs integration in this account.
Type: Array of IntegrationSummary objects
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
- ServiceUnavailableException
-
The service cannot complete the request.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
