CloudWatchLogs / Client / list_integrations

list_integrations#

CloudWatchLogs.Client.list_integrations(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_integrations(
    integrationNamePrefix='string',
    integrationType='OPENSEARCH',
    integrationStatus='PROVISIONING'|'ACTIVE'|'FAILED'
)
Parameters:

  • integrationNamePrefix (string) – To limit the results to integrations that start with a certain name prefix, specify that name prefix here.

  • integrationType (string) – To limit the results to integrations of a certain type, specify that type here.

  • integrationStatus (string) – To limit the results to integrations with a certain status, specify that status here.

Return type:

dict

Returns:

Response Syntax

{
    'integrationSummaries': [
        {
            'integrationName': 'string',
            'integrationType': 'OPENSEARCH',
            'integrationStatus': 'PROVISIONING'|'ACTIVE'|'FAILED'
        },
    ]
}

Response Structure

  • (dict) –

    • integrationSummaries (list) –

      An array, where each object in the array contains information about one CloudWatch Logs integration in this account.

      • (dict) –

        This structure contains information about one CloudWatch Logs integration. This structure is returned by a ListIntegrations operation.

        • integrationName (string) –

          The name of this integration.

        • integrationType (string) –

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

        • integrationStatus (string) –

          The current status of this integration.

Exceptions

  • CloudWatchLogs.Client.exceptions.InvalidParameterException

  • CloudWatchLogs.Client.exceptions.ServiceUnavailableException