Describes an agent status.
Parameters:
-
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.
-
agent_status_id
(AgentStatusId)
–
The identifier for the agent status.
Raises:
Source code in docs_src/capo_connect/_services/connect.py
| def describe_agent_status(
self,
instance_id: "capo_connect.types.instance_id.InstanceId",
agent_status_id: "capo_connect.types.agent_status_id.AgentStatusId",
*,
config_overrides: Optional[ConnectClientConfig] = None,
) -> (
"capo_connect.types.describe_agent_status_response.DescribeAgentStatusResponse"
):
"""<p>Describes an agent status.</p>
Args:
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>
agent_status_id: <p>The identifier for the agent status.</p>
Raises:
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_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</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.describe_agent_status_request.DescribeAgentStatusRequest]",
) -> OperationResponse[
"capo_connect.types.describe_agent_status_response.DescribeAgentStatusResponse"
]:
import capo_connect._operations.amazon_connect_service.describe_agent_status
output, http_response = (
capo_connect._operations.amazon_connect_service.describe_agent_status.describe_agent_status(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeAgentStatus")
)
input_: capo_connect.types.describe_agent_status_request.DescribeAgentStatusRequest = {
"instance_id": instance_id,
"agent_status_id": agent_status_id,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|