Skip to content

list_traffic_distribution_groups async

list_traffic_distribution_groups(
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    max_results: Optional[MaxResult10] = None,
    next_token: Optional[NextToken] = None,
    instance_id: Optional[ACGRInstanceIdOrArn] = None,
) -> ListTrafficDistributionGroupsResponse

Lists traffic distribution groups.

Parameters:

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

    The maximum number of results to return per page.

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

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • instance_id (Optional[ACGRInstanceIdOrArn], default: None ) –

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Raises:

Source code in docs_src/capo_connect/_services/async_connect.py
async def list_traffic_distribution_groups(
    self,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    max_results: Optional["capo_connect.types.max_result10.MaxResult10"] = None,
    next_token: Optional["capo_connect.types.next_token.NextToken"] = None,
    instance_id: Optional[
        "capo_connect.types.acgr_instance_id_or_arn.ACGRInstanceIdOrArn"
    ] = None,
) -> "capo_connect.types.list_traffic_distribution_groups_response.ListTrafficDistributionGroupsResponse":
    """<p>Lists traffic distribution groups.</p>

    Args:
        max_results: <p>The maximum number of results to return per page.</p>
        next_token: <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.list_traffic_distribution_groups_request.ListTrafficDistributionGroupsRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.list_traffic_distribution_groups_response.ListTrafficDistributionGroupsResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.list_traffic_distribution_groups

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.list_traffic_distribution_groups.async_list_traffic_distribution_groups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTrafficDistributionGroups")
    )
    input_: capo_connect.types.list_traffic_distribution_groups_request.ListTrafficDistributionGroupsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if instance_id is not None:
        input_["instance_id"] = instance_id

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