Skip to content

list_integrations async

list_integrations(
    *,
    config_overrides: Optional[AsyncCloudWatchOmniClientConfig] = None,
    integration_type: Optional[IntegrationType] = None,
    status: Optional[IntegrationStatus] = None,
    name: Optional[str] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> ListIntegrationsOutput

Lists the integrations in the account, optionally filtered by type, status, or name. Results are paginated.

Parameters:

  • integration_type (Optional[IntegrationType], default: None ) –

    Returns only integrations of this provider type.

  • status (Optional[IntegrationStatus], default: None ) –

    Returns only integrations in this status.

  • name (Optional[str], default: None ) –

    Returns only the integration with this exact name.

  • next_token (Optional[str], default: None ) –

    Pagination token from a previous response; omit for the first page.

  • max_results (Optional[int], default: None ) –

    Maximum number of integrations to return in one page.

Raises:

Examples:

List integrations of a type The following example lists up to 20 AWS_INTEGRATION integrations in the account. Payloads are shown as JSON; on the wire they are CBOR-encoded.

>>> await client.list_integrations(integration_type='AWS_INTEGRATION', max_results=20)
Source code in docs_src/capo_cloudwatchomni/_services/async_cloud_watch_omni.py
async def list_integrations(
    self,
    *,
    config_overrides: Optional[AsyncCloudWatchOmniClientConfig] = None,
    integration_type: Optional[
        "capo_cloudwatchomni.types.integration_type.IntegrationType"
    ] = None,
    status: Optional[
        "capo_cloudwatchomni.types.integration_status.IntegrationStatus"
    ] = None,
    name: Optional[str] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> "capo_cloudwatchomni.types.list_integrations_output.ListIntegrationsOutput":
    """Lists the integrations in the account, optionally filtered by type, status, or name. Results are paginated.

    Args:
        integration_type: Returns only integrations of this provider type.
        status: Returns only integrations in this status.
        name: Returns only the integration with this exact name.
        next_token: Pagination token from a previous response; omit for the first page.
        max_results: Maximum number of integrations to return in one page.

    Raises:
        capo_cloudwatchomni.errors.access_denied_exception.AccessDeniedException: The caller is not authorized to perform this action.
        capo_cloudwatchomni.errors.internal_server_exception.InternalServerException: An unexpected error occurred while processing the request.
        capo_cloudwatchomni.errors.throttling_exception.ThrottlingException: The request was throttled due to exceeding the allowed request rate.
        capo_cloudwatchomni.errors.validation_exception.ValidationException: A parameter is specified incorrectly.
        capo_cloudwatchomni.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List integrations of a type
        The following example lists up to 20 AWS_INTEGRATION integrations in the account. Payloads are shown as JSON; on the wire they are CBOR-encoded.

        >>> await client.list_integrations(integration_type='AWS_INTEGRATION', max_results=20)
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudwatchomni.types.list_integrations_input.ListIntegrationsInput]",
    ) -> AsyncOperationResponse[
        "capo_cloudwatchomni.types.list_integrations_output.ListIntegrationsOutput"
    ]:
        import capo_cloudwatchomni._operations.cloud_watch_omni_frontend.list_integrations

        (
            output,
            http_response,
        ) = await capo_cloudwatchomni._operations.cloud_watch_omni_frontend.list_integrations.async_list_integrations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListIntegrations")
    )
    input_: capo_cloudwatchomni.types.list_integrations_input.ListIntegrationsInput = {}
    if integration_type is not None:
        input_["integration_type"] = integration_type
    if status is not None:
        input_["status"] = status
    if name is not None:
        input_["name"] = name
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output