Skip to content

list_traffic_distribution_group_users

list_traffic_distribution_group_users(
    traffic_distribution_group_id: TrafficDistributionGroupIdOrArn,
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    max_results: Optional[MaxResult1000] = None,
    next_token: Optional[NextToken] = None,
) -> ListTrafficDistributionGroupUsersResponse

Lists traffic distribution group users.

Parameters:

  • traffic_distribution_group_id (TrafficDistributionGroupIdOrArn) –

    The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

  • max_results (Optional[MaxResult1000], 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.

Raises:

Source code in docs_src/capo_connect/_services/connect.py
def list_traffic_distribution_group_users(
    self,
    traffic_distribution_group_id: "capo_connect.types.traffic_distribution_group_id_or_arn.TrafficDistributionGroupIdOrArn",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    max_results: Optional["capo_connect.types.max_result1000.MaxResult1000"] = None,
    next_token: Optional["capo_connect.types.next_token.NextToken"] = None,
) -> "capo_connect.types.list_traffic_distribution_group_users_response.ListTrafficDistributionGroupUsersResponse":
    """<p>Lists traffic distribution group users.</p>

    Args:
        traffic_distribution_group_id: <p>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.</p>
        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>

    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.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</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.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.list_traffic_distribution_group_users_request.ListTrafficDistributionGroupUsersRequest]",
    ) -> OperationResponse[
        "capo_connect.types.list_traffic_distribution_group_users_response.ListTrafficDistributionGroupUsersResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.list_traffic_distribution_group_users

        output, http_response = (
            capo_connect._operations.amazon_connect_service.list_traffic_distribution_group_users.list_traffic_distribution_group_users(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTrafficDistributionGroupUsers")
    )
    input_: capo_connect.types.list_traffic_distribution_group_users_request.ListTrafficDistributionGroupUsersRequest = {
        "traffic_distribution_group_id": traffic_distribution_group_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output