delete_traffic_distribution_group `async` ¶

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

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Connect Customer Administrator Guide.

Parameters:

traffic_distribution_group_id (TrafficDistributionGroupIdOrArn) –

The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.

Raises:

AccessDeniedException –

You do not have sufficient permissions to perform this action.
InternalServiceException –

Request processing failed because of an error or failure with the service.
InvalidRequestException –

The request is not valid.
ResourceInUseException –

That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.
ThrottlingException –

The throttling limit has been exceeded.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_connect/_services/async_connect.py

async def delete_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.delete_traffic_distribution_group_response.DeleteTrafficDistributionGroupResponse":
    """<p>Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.</p> <p>For more information about deleting traffic distribution groups, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/delete-traffic-distribution-groups.html">Delete traffic distribution groups</a> in the <i>Connect Customer Administrator Guide</i>.</p>

    Args:
        traffic_distribution_group_id: <p>The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.</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_in_use_exception.ResourceInUseException: <p>That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.</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.delete_traffic_distribution_group_request.DeleteTrafficDistributionGroupRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.delete_traffic_distribution_group_response.DeleteTrafficDistributionGroupResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.delete_traffic_distribution_group

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteTrafficDistributionGroup")
    )
    input_: capo_connect.types.delete_traffic_distribution_group_request.DeleteTrafficDistributionGroupRequest = {
        "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

delete_traffic_distribution_group async ¶

delete_traffic_distribution_group `async` ¶