Skip to content

list_connectors async

list_connectors(
    *,
    config_overrides: Optional[AsyncSecurityHubClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
    provider_name: Optional[CspmConnectorProviderName] = None,
    connector_status: Optional[CspmConnectorStatus] = None,
    enablement_status: Optional[CspmEnablementStatus] = None,
) -> ListConnectorsResponse

Lists the CSPM connectors and their metadata for the calling account.

Parameters:

Raises:

Examples:

To list CSPM connectors This operation lists the CSPM connectors for the calling account.

>>> await client.list_connectors(max_results=10)
Source code in docs_src/capo_securityhub/_services/async_security_hub.py
async def list_connectors(
    self,
    *,
    config_overrides: Optional[AsyncSecurityHubClientConfig] = None,
    next_token: Optional["capo_securityhub.types.next_token.NextToken"] = None,
    max_results: Optional["capo_securityhub.types.max_results.MaxResults"] = None,
    provider_name: Optional[
        "capo_securityhub.types.cspm_connector_provider_name.CspmConnectorProviderName"
    ] = None,
    connector_status: Optional[
        "capo_securityhub.types.cspm_connector_status.CspmConnectorStatus"
    ] = None,
    enablement_status: Optional[
        "capo_securityhub.types.cspm_enablement_status.CspmEnablementStatus"
    ] = None,
) -> "capo_securityhub.types.list_connectors_response.ListConnectorsResponse":
    """<p>Lists the CSPM connectors and their metadata for the calling account.</p>

    Args:
        next_token: <p>The pagination token to request the next page of results.</p>
        max_results: <p>The maximum number of results to return.</p>
        provider_name: <p>The name of the cloud provider to filter connectors by.</p>
        connector_status: <p>The connectivity status to filter connectors by.</p>
        enablement_status: <p>The enablement status to filter connectors by.</p>

    Raises:
        capo_securityhub.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action specified in the request.</p>
        capo_securityhub.errors.conflict_exception.ConflictException: <p>The request causes conflict with the current state of the service resource.</p>
        capo_securityhub.errors.internal_server_exception.InternalServerException: <p> The request has failed due to an internal failure of the service. </p>
        capo_securityhub.errors.invalid_access_exception.InvalidAccessException: <p>The account doesn't have permission to perform this action.</p>
        capo_securityhub.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request was rejected because we can't find the specified resource.</p>
        capo_securityhub.errors.throttling_exception.ThrottlingException: <p> The limit on the number of requests per second was exceeded. </p>
        capo_securityhub.errors.validation_exception.ValidationException: <p>The request has failed validation because it's missing required fields or has invalid inputs.</p>
        capo_securityhub.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To list CSPM connectors
        This operation lists the CSPM connectors for the calling account.

        >>> await client.list_connectors(max_results=10)
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_securityhub.types.list_connectors_request.ListConnectorsRequest]",
    ) -> AsyncOperationResponse[
        "capo_securityhub.types.list_connectors_response.ListConnectorsResponse"
    ]:
        import capo_securityhub._operations.security_hub_api_service.list_connectors

        (
            output,
            http_response,
        ) = await capo_securityhub._operations.security_hub_api_service.list_connectors.async_list_connectors(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListConnectors")
    )
    input_: capo_securityhub.types.list_connectors_request.ListConnectorsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if provider_name is not None:
        input_["provider_name"] = provider_name
    if connector_status is not None:
        input_["connector_status"] = connector_status
    if enablement_status is not None:
        input_["enablement_status"] = enablement_status

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