Skip to content

list_subscriptions async 

list_subscriptions(
    domain_id: DomainId,
    *,
    config_overrides: Optional[AsyncConnectHealthClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
) -> ListSubscriptionsOutput

Lists all Subscriptions within a Domain.

Parameters:

  • domain_id (DomainId) –

    The unique identifier of the parent Domain.

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

    Maximum number of results to return.

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

    Token for pagination.

Raises:

Source code in docs_src/capo_connecthealth/_services/async_connect_health.py 
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
async def list_subscriptions(
    self,
    domain_id: "capo_connecthealth.types.domain_id.DomainId",
    *,
    config_overrides: Optional[AsyncConnectHealthClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
) -> "capo_connecthealth.types.list_subscriptions_output.ListSubscriptionsOutput":
    """<p>Lists all Subscriptions within a Domain.</p>

    Args:
        domain_id: <p>The unique identifier of the parent Domain.</p>
        max_results: <p>Maximum number of results to return.</p>
        next_token: <p>Token for pagination.</p>

    Raises:
        capo_connecthealth.errors.access_denied_exception.AccessDeniedException: <p>This error is thrown when the client does not supply proper credentials to the API.</p>
        capo_connecthealth.errors.internal_server_exception.InternalServerException: <p>This error is thrown when a transient error causes our API to fail.</p>
        capo_connecthealth.errors.resource_not_found_exception.ResourceNotFoundException: <p>This error is thrown when the requested resource is not found.</p>
        capo_connecthealth.errors.validation_exception.ValidationException: <p>This error is thrown when the client supplies invalid input to the API.</p>
        capo_connecthealth.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connecthealth.types.list_subscriptions_input.ListSubscriptionsInput]",
    ) -> AsyncOperationResponse[
        "capo_connecthealth.types.list_subscriptions_output.ListSubscriptionsOutput"
    ]:
        import capo_connecthealth._operations.connect_health.list_subscriptions

        (
            output,
            http_response,
        ) = await capo_connecthealth._operations.connect_health.list_subscriptions.async_list_subscriptions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSubscriptions")
    )
    input_: capo_connecthealth.types.list_subscriptions_input.ListSubscriptionsInput = {
        "domain_id": domain_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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