describe_user ¶

def describe_user(
    self,
    server_id: "capo_transfer.types.server_id.ServerId",
    user_name: "capo_transfer.types.user_name.UserName",
    *,
    config_overrides: Optional[TransferClientConfig] = None,
) -> "capo_transfer.types.describe_user_response.DescribeUserResponse":
    """<p>Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its <code>ServerId</code> property.</p> <p>The response from this call returns the properties of the user associated with the <code>ServerId</code> value that was specified.</p>

    Args:
        server_id: <p>A system-assigned unique identifier for a server that has this user assigned.</p>
        user_name: <p>The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the Transfer Family service and perform file transfer tasks.</p>

    Raises:
        capo_transfer.errors.internal_service_error.InternalServiceError: <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
        capo_transfer.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_transfer.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
        capo_transfer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
        capo_transfer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_transfer.types.describe_user_request.DescribeUserRequest]",
    ) -> OperationResponse[
        "capo_transfer.types.describe_user_response.DescribeUserResponse"
    ]:
        import capo_transfer._operations.transfer_service.describe_user

        output, http_response = (
            capo_transfer._operations.transfer_service.describe_user.describe_user(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeUser")
    )
    input_: capo_transfer.types.describe_user_request.DescribeUserRequest = {
        "server_id": server_id,
        "user_name": user_name,
    }

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