Skip to content

describe_traffic_distribution_group async

describe_traffic_distribution_group(
    traffic_distribution_group_id: TrafficDistributionGroupIdOrArn,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> DescribeTrafficDistributionGroupResponse

Gets details and status of a traffic distribution group.

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.

Raises:

Source code in docs_src/capo_connect/_services/async_connect.py
async def describe_traffic_distribution_group(
    self,
    traffic_distribution_group_id: "capo_connect.types.traffic_distribution_group_id_or_arn.TrafficDistributionGroupIdOrArn",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> "capo_connect.types.describe_traffic_distribution_group_response.DescribeTrafficDistributionGroupResponse":
    """<p>Gets details and status of a traffic distribution group.</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>

    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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.describe_traffic_distribution_group_request.DescribeTrafficDistributionGroupRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.describe_traffic_distribution_group_response.DescribeTrafficDistributionGroupResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.describe_traffic_distribution_group

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTrafficDistributionGroup")
    )
    input_: capo_connect.types.describe_traffic_distribution_group_request.DescribeTrafficDistributionGroupRequest = {
        "traffic_distribution_group_id": traffic_distribution_group_id
    }

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