Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
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.
-
user_id
(UserId)
–
The identifier of the user account. This can be the ID or the ARN of the user.
-
instance_id
(InstanceId)
–
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/connect.py
| def associate_traffic_distribution_group_user(
self,
traffic_distribution_group_id: "capo_connect.types.traffic_distribution_group_id_or_arn.TrafficDistributionGroupIdOrArn",
user_id: "capo_connect.types.user_id.UserId",
instance_id: "capo_connect.types.instance_id.InstanceId",
*,
config_overrides: Optional[ConnectClientConfig] = None,
) -> "capo_connect.types.associate_traffic_distribution_group_user_response.AssociateTrafficDistributionGroupUserResponse":
"""<p>Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.</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>
user_id: <p>The identifier of the user account. This can be the ID or the ARN of the user. </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.resource_conflict_exception.ResourceConflictException: <p>A resource already has that name.</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.associate_traffic_distribution_group_user_request.AssociateTrafficDistributionGroupUserRequest]",
) -> OperationResponse[
"capo_connect.types.associate_traffic_distribution_group_user_response.AssociateTrafficDistributionGroupUserResponse"
]:
import capo_connect._operations.amazon_connect_service.associate_traffic_distribution_group_user
output, http_response = (
capo_connect._operations.amazon_connect_service.associate_traffic_distribution_group_user.associate_traffic_distribution_group_user(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("AssociateTrafficDistributionGroupUser")
)
input_: capo_connect.types.associate_traffic_distribution_group_user_request.AssociateTrafficDistributionGroupUserRequest = {
"traffic_distribution_group_id": traffic_distribution_group_id,
"user_id": user_id,
"instance_id": instance_id,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|